diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index c7099192dba6..2eb320983f6a 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -1,5 +1,5 @@ # To find available Node images, see https://mcr.microsoft.com/en-us/product/devcontainers/javascript-node/tags # [Choice] Node.js version -ARG VARIANT="dev-22-bullseye" +ARG VARIANT="dev-24-bullseye" FROM mcr.microsoft.com/devcontainers/javascript-node:${VARIANT} diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 3de3f41ff020..6a42a1d9790d 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -6,7 +6,7 @@ "build": { "dockerfile": "Dockerfile", // Update 'VARIANT' to pick a Node version - "args": { "VARIANT": "22" } + "args": { "VARIANT": "24" } }, // Install features. Type 'feature' in the VS Code command palette for a full list. diff --git a/.github/actions/get-changed-files/get-changed-files.sh b/.github/actions/get-changed-files/get-changed-files.sh index c9e25549f1de..a2f49f8b0d93 100755 --- a/.github/actions/get-changed-files/get-changed-files.sh +++ b/.github/actions/get-changed-files/get-changed-files.sh @@ -18,8 +18,9 @@ git fetch --depth=1 origin main git fetch --depth=1 origin ${INPUT_HEAD:-HEAD} # Get diff with status information +# Find the merge-base (common ancestor) instead of using origin/main directly echo "__ running git diff with status __" -DIFF_OUTPUT=$(git diff --name-status origin/main origin/${INPUT_HEAD:-HEAD}) +DIFF_OUTPUT=$(git diff --name-status origin/main...origin/${INPUT_HEAD:-HEAD}) # Function to extract files by pattern from diff output extract_files() { diff --git a/.github/workflows/article-api-docs.yml b/.github/workflows/article-api-docs.yml index be55be40cb46..4f87a815b93b 100644 --- a/.github/workflows/article-api-docs.yml +++ b/.github/workflows/article-api-docs.yml @@ -18,7 +18,7 @@ permissions: jobs: check-content-linter-rules-docs: - runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }} + runs-on: ubuntu-latest if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' steps: - name: Checkout diff --git a/.github/workflows/content-lint-markdown.yml b/.github/workflows/content-lint-markdown.yml index ac80a26e1fbf..f097e34e364b 100644 --- a/.github/workflows/content-lint-markdown.yml +++ b/.github/workflows/content-lint-markdown.yml @@ -20,7 +20,7 @@ permissions: jobs: lint-content: if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' - runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }} + runs-on: ubuntu-latest steps: - name: Check out repo uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 diff --git a/.github/workflows/content-linter-rules-docs.yml b/.github/workflows/content-linter-rules-docs.yml index ebdcb64ca5a6..fe1dc03ca736 100644 --- a/.github/workflows/content-linter-rules-docs.yml +++ b/.github/workflows/content-linter-rules-docs.yml @@ -21,7 +21,7 @@ permissions: jobs: check-content-linter-rules-docs: - runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }} + runs-on: ubuntu-latest if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' steps: - name: Checkout diff --git a/.github/workflows/count-translation-corruptions.yml b/.github/workflows/count-translation-corruptions.yml index 87c96c225b0a..9b6b134a666b 100644 --- a/.github/workflows/count-translation-corruptions.yml +++ b/.github/workflows/count-translation-corruptions.yml @@ -21,7 +21,7 @@ permissions: jobs: count-translation-corruptions: if: github.repository == 'github/docs-internal' - runs-on: ubuntu-20.04-xl + runs-on: ubuntu-latest steps: - name: Checkout English repo uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 diff --git a/.github/workflows/generate-code-scanning-query-lists.yml b/.github/workflows/generate-code-scanning-query-lists.yml index 1c62e4e779b1..200b5b3527db 100644 --- a/.github/workflows/generate-code-scanning-query-lists.yml +++ b/.github/workflows/generate-code-scanning-query-lists.yml @@ -29,7 +29,7 @@ permissions: jobs: generate-query-lists: if: github.repository == 'github/docs-internal' - runs-on: ubuntu-20.04-xl + runs-on: ubuntu-latest steps: - name: Checkout repository code uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 diff --git a/.github/workflows/headless-tests.yml b/.github/workflows/headless-tests.yml index 5c1ced60b3ff..6b1f78b76a41 100644 --- a/.github/workflows/headless-tests.yml +++ b/.github/workflows/headless-tests.yml @@ -25,7 +25,7 @@ env: jobs: playwright-tests: if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' - runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }} + runs-on: ubuntu-latest strategy: # When we're comfortable a11y tests aren't generating false positives and helping, # let's remove the matrix and just run playwright in a single job. diff --git a/.github/workflows/index-autocomplete-search.yml b/.github/workflows/index-autocomplete-search.yml index fb9fdfe8924a..79582d796aca 100644 --- a/.github/workflows/index-autocomplete-search.yml +++ b/.github/workflows/index-autocomplete-search.yml @@ -20,7 +20,7 @@ permissions: jobs: index-autocomplete-elasticsearch: if: ${{ github.repository == 'github/docs-internal' }} - runs-on: ubuntu-20.04-xl + runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 diff --git a/.github/workflows/index-general-search-pr.yml b/.github/workflows/index-general-search-pr.yml index 70e565cf25ee..96127559d3c9 100644 --- a/.github/workflows/index-general-search-pr.yml +++ b/.github/workflows/index-general-search-pr.yml @@ -33,7 +33,7 @@ env: jobs: dryRunElasticsearchIndexes: - runs-on: ubuntu-20.04-xl + runs-on: ubuntu-latest if: github.repository == 'github/docs-internal' steps: - name: Check out repo diff --git a/.github/workflows/index-general-search.yml b/.github/workflows/index-general-search.yml index 90e086b3cf7a..ce4abbbef3c0 100644 --- a/.github/workflows/index-general-search.yml +++ b/.github/workflows/index-general-search.yml @@ -98,7 +98,7 @@ jobs: needs: figureOutMatrix name: Update indexes if: ${{ github.repository == 'github/docs-internal' && needs.figureOutMatrix.outputs.matrix != '[]' }} - runs-on: ubuntu-20.04-xl + runs-on: ubuntu-latest strategy: fail-fast: false # When it's only English (i.e. a simple array of ['en']), this value diff --git a/.github/workflows/keep-caches-warm.yml b/.github/workflows/keep-caches-warm.yml index 35163e1fd608..04daa6d9c045 100644 --- a/.github/workflows/keep-caches-warm.yml +++ b/.github/workflows/keep-caches-warm.yml @@ -26,7 +26,7 @@ permissions: jobs: keep-caches-warm: if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' - runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }} + runs-on: ubuntu-latest steps: - name: Check out repo uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 diff --git a/.github/workflows/link-check-daily.yml b/.github/workflows/link-check-daily.yml index 9c4ffa005529..1f0876acbd22 100644 --- a/.github/workflows/link-check-daily.yml +++ b/.github/workflows/link-check-daily.yml @@ -17,7 +17,7 @@ jobs: check_all_english_links: name: Check all links if: github.repository == 'github/docs-internal' - runs-on: ubuntu-20.04-xl + runs-on: ubuntu-latest steps: - name: Check that gh CLI is installed run: gh --version diff --git a/.github/workflows/link-check-on-pr.yml b/.github/workflows/link-check-on-pr.yml index df5d39e47d77..c91fe77e9324 100644 --- a/.github/workflows/link-check-on-pr.yml +++ b/.github/workflows/link-check-on-pr.yml @@ -22,7 +22,7 @@ concurrency: jobs: check-links: - runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }} + runs-on: ubuntu-latest if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' steps: - name: Checkout diff --git a/.github/workflows/lint-code.yml b/.github/workflows/lint-code.yml index 0ee0a8758b3a..7506716f6d66 100644 --- a/.github/workflows/lint-code.yml +++ b/.github/workflows/lint-code.yml @@ -20,7 +20,7 @@ concurrency: jobs: lint-code: if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' - runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }} + runs-on: ubuntu-latest steps: - name: Check out repo uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 diff --git a/.github/workflows/lint-entire-content-data-markdown.yml b/.github/workflows/lint-entire-content-data-markdown.yml index b2d57e2e3699..42699314f95d 100644 --- a/.github/workflows/lint-entire-content-data-markdown.yml +++ b/.github/workflows/lint-entire-content-data-markdown.yml @@ -17,7 +17,7 @@ jobs: lint-entire-content-data: name: Lint entire content and data directories if: github.repository == 'github/docs-internal' - runs-on: ubuntu-20.04-xl + runs-on: ubuntu-latest steps: - name: Check that gh CLI is installed run: gh --version diff --git a/.github/workflows/local-dev.yml b/.github/workflows/local-dev.yml index 55acf15eafb5..1b6d0d4b3603 100644 --- a/.github/workflows/local-dev.yml +++ b/.github/workflows/local-dev.yml @@ -16,7 +16,7 @@ permissions: jobs: local-dev: if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' - runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }} + runs-on: ubuntu-latest steps: - name: Check out repo uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 @@ -51,7 +51,7 @@ jobs: PLAYWRIGHT_RETRIES: 0 TEST_EARLY_ACCESS: ${{ github.repository == 'github/docs-internal' }} # workaround for https://github.com/nodejs/node/issues/59364 as of 22.18.0 - NODE_OPTIONS: '--no-experimental-strip-types' + NODE_OPTIONS: '--no-experimental-strip-types --max-old-space-size=8192' run: npm run playwright-test -- playwright-local-dev - name: Start server in the background diff --git a/.github/workflows/readability.yml b/.github/workflows/readability.yml index bc338c130714..32ffec056a33 100644 --- a/.github/workflows/readability.yml +++ b/.github/workflows/readability.yml @@ -25,7 +25,7 @@ permissions: jobs: readability-analysis: if: github.repository == 'github/docs-internal' - runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }} + runs-on: ubuntu-latest steps: - name: Check out repo with full history uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 diff --git a/.github/workflows/sync-openapi.yml b/.github/workflows/sync-openapi.yml index 4344dd0ff801..f43b9ccc6666 100644 --- a/.github/workflows/sync-openapi.yml +++ b/.github/workflows/sync-openapi.yml @@ -27,7 +27,7 @@ concurrency: jobs: generate-decorated-files: if: github.repository == 'github/docs-internal' - runs-on: ubuntu-20.04-xl + runs-on: ubuntu-latest steps: - name: Checkout repository code uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 diff --git a/.github/workflows/test-changed-content.yml b/.github/workflows/test-changed-content.yml index fa7f56180243..2e2548c7b77a 100644 --- a/.github/workflows/test-changed-content.yml +++ b/.github/workflows/test-changed-content.yml @@ -21,7 +21,7 @@ permissions: jobs: test-changed-content: - runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }} + runs-on: ubuntu-latest if: ${{ github.repository == 'github/docs-internal' || github.repository == 'github/docs' }} steps: # Each of these ifs needs to be repeated at each step to make sure the required check still runs diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index be7019e9b837..e9892fffcea0 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -27,10 +27,7 @@ jobs: test: name: ${{ matrix.name }} if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' - - # Run on ubuntu-20.04-xl if the private repo or ubuntu-latest if the public repo - # See pull # 17442 in the private repo for context - runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }} + runs-on: ubuntu-latest timeout-minutes: 60 strategy: fail-fast: false diff --git a/.github/workflows/validate-github-github-docs-urls.yml b/.github/workflows/validate-github-github-docs-urls.yml index 4f5609b0f490..d53df2636b5e 100644 --- a/.github/workflows/validate-github-github-docs-urls.yml +++ b/.github/workflows/validate-github-github-docs-urls.yml @@ -31,7 +31,7 @@ jobs: validate_github_github_docs_urls: name: Validate github/github docs URLs if: github.repository == 'github/docs-internal' - runs-on: ubuntu-20.04-xl + runs-on: ubuntu-latest steps: - name: Check out repo's default branch uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 diff --git a/CHANGELOG.md b/CHANGELOG.md index e4f1df059248..a3655b75bd02 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Docs changelog +**11 September 2025** + +You can now enable automatic Copilot code review with its own standalone repository rule. We've updated the documentation accordingly. + +See [Configuring automatic code review by GitHub Copilot](https://docs.github.com/copilot/how-tos/use-copilot-agents/request-a-code-review/configure-automatic-review). + +
+ **4 September 2025** We've updated the documentation to remove references to Copilot coding guidelines. diff --git a/Dockerfile b/Dockerfile index 780e7c5ccc58..c8abbbc3a30c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -17,7 +17,7 @@ FROM ghcr.io/github/gh-base-image/gh-base-noble:20250805-204228-g50c20871f AS ba # Ubuntu's apt-get install nodejs is _very_ outdated # Must run as root RUN apt-get -qq update && apt-get -qq install --no-install-recommends curl git \ - && curl -sL https://deb.nodesource.com/setup_22.x | bash - \ + && curl -sL https://deb.nodesource.com/setup_24.x | bash - \ && apt-get install -y nodejs \ && node --version diff --git a/assets/images/banner-images/hero-1.png b/assets/images/banner-images/hero-1.png new file mode 100644 index 000000000000..60df8ea86ed2 Binary files /dev/null and b/assets/images/banner-images/hero-1.png differ diff --git a/assets/images/banner-images/hero-2.png b/assets/images/banner-images/hero-2.png new file mode 100644 index 000000000000..0d02dfd6c078 Binary files /dev/null and b/assets/images/banner-images/hero-2.png differ diff --git a/assets/images/banner-images/hero-3.png b/assets/images/banner-images/hero-3.png new file mode 100644 index 000000000000..7de28041c963 Binary files /dev/null and b/assets/images/banner-images/hero-3.png differ diff --git a/assets/images/banner-images/hero-4.png b/assets/images/banner-images/hero-4.png new file mode 100644 index 000000000000..8d2bcb1ebaf6 Binary files /dev/null and b/assets/images/banner-images/hero-4.png differ diff --git a/assets/images/banner-images/hero-5.png b/assets/images/banner-images/hero-5.png new file mode 100644 index 000000000000..ef06249436e7 Binary files /dev/null and b/assets/images/banner-images/hero-5.png differ diff --git a/assets/images/banner-images/hero-6.png b/assets/images/banner-images/hero-6.png new file mode 100644 index 000000000000..3f68a2ebdf33 Binary files /dev/null and b/assets/images/banner-images/hero-6.png differ diff --git a/assets/images/help/copilot/vsc-manage-models-list.png b/assets/images/help/copilot/vsc-manage-models-list.png new file mode 100644 index 000000000000..4144779f539e Binary files /dev/null and b/assets/images/help/copilot/vsc-manage-models-list.png differ diff --git a/assets/images/help/copilot/vsc-manage-models-option.png b/assets/images/help/copilot/vsc-manage-models-option.png new file mode 100644 index 000000000000..bcc1d114b7e8 Binary files /dev/null and b/assets/images/help/copilot/vsc-manage-models-option.png differ diff --git a/content/account-and-profile/concepts/changing-your-github-username.md b/content/account-and-profile/concepts/changing-your-github-username.md deleted file mode 100644 index fee5f1777ccc..000000000000 --- a/content/account-and-profile/concepts/changing-your-github-username.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -title: Changing your GitHub username -intro: 'You can change the username for your account on {% data variables.product.prodname_dotcom %}{% ifversion ghes %} if your instance uses built-in authentication{% endif %}.' -redirect_from: - - /articles/how-to-change-your-username - - /articles/changing-your-github-user-name - - /articles/renaming-a-user - - /articles/what-happens-when-i-change-my-username - - /articles/changing-your-github-username - - /github/setting-up-and-managing-your-github-user-account/changing-your-github-username - - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/changing-your-github-username - - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/changing-your-github-username - - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username - - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/changing-your-github-username -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Accounts -shortTitle: Change your username ---- - -{% ifversion ghec or ghes %} - -{% ifversion ghec %} - -> [!NOTE] -> Members of an {% data variables.enterprise.prodname_emu_enterprise %} cannot change usernames. Your enterprise's IdP administrator controls your {% data variables.product.github %} username. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). - -{% elsif ghes %} - -> [!NOTE] -> If you sign into {% data variables.location.product_location %} with LDAP credentials or single sign-on (SSO), only your local administrator can change your username. For more information about authentication methods for {% data variables.product.prodname_ghe_server %}, see [AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise). - -{% endif %} - -{% endif %} - -## About username changes - -You can change your username to another username that is not currently in use.{% ifversion fpt or ghec %} If the username you want is not available, consider other names or unique variations. Using a number, hyphen, or an alternative spelling might help you find a similar username that's still available. - -If you hold a trademark for the username, you can find more information about making a trademark complaint on our [Trademark Policy](/free-pro-team@latest/site-policy/content-removal-policies/github-trademark-policy) page. - -If you do not hold a trademark for the name, you can choose another username or keep your current username. {% data variables.contact.github_support %} cannot release the unavailable username for you. For more information, see [Changing your username](#changing-your-username).{% endif %} - -After changing your username, your old username becomes available for anyone else to claim. Most references to your repositories under the old username automatically change to the new username. However, some links to your profile won't automatically redirect. - -{% data variables.product.github %} cannot set up redirects for: -* [@mentions](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#mentioning-people-and-teams) using your old username -* Links to [gists](/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists) that include your old username - -{% ifversion fpt or ghec %} - -If you're a member of an {% data variables.enterprise.prodname_emu_enterprise %}, you cannot make changes to your username. {% data reusables.enterprise-accounts.emu-more-info-account %} - -{% endif %} - -{% ifversion fpt or ghec %} - -{% data reusables.accounts.rename-account-repo-namespace-retirement %} If you try to create a repository using a retired owner name and repository name combination, you will see the error: "The repository `` has been retired and cannot be reused." - -{% endif %} - -{% data reusables.package_registry.rename-account-namespace-retirement %} - -## Repository references - -After you change your username, {% data variables.product.github %} will automatically redirect references to your repositories. -* Web links to your existing repositories will continue to work. This can take a few minutes to complete after you make the change. -* Command line pushes from your local repository clones to the old remote tracking URLs will continue to work. - -If the new owner of your old username creates a repository with the same name as your repository, that will override the redirect entry and your redirect will stop working. Because of this possibility, we recommend you update all existing remote repository URLs after changing your username. For more information, see [AUTOTITLE](/get-started/git-basics/managing-remote-repositories). - -## Links to your previous profile page - -After changing your username, links to your previous profile page, such as `https://{% data variables.product.product_url %}/previoususername`, will return a 404 error. We recommend updating any links to your profile from elsewhere{% ifversion fpt or ghec %}, such as your LinkedIn or Twitter profile{% endif %}. - -## Accounts logged in on GitHub Mobile - -Accounts logged in on the {% data variables.product.prodname_mobile %} app may continue to display your original username until you log out. To ensure your updated username is displayed, we recommend you sign out and back in to your account on each mobile device. - -## Your Git commits - -If your Git commits are associated with another email address you've added to your {% data variables.product.prodname_dotcom %} account, they'll continue to be attributed to you and appear in your contributions graph after you've changed your username. For more information on setting your email address, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address) and [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account). - -{% ifversion fpt or ghec %}If you've been using a {% data variables.product.prodname_dotcom %}-provided private commit email address, whether or not your commit history will be retained after an account rename depends on the format of the email address. Git commits that are associated with your {% data variables.product.github %}-provided `noreply` email address won't be attributed to your new username and won't appear in your contributions graph, unless your `noreply` email address is in the form of `ID+USERNAME@users.noreply.github.com`. Older versions of the `noreply` email address that do not contain a numeric ID will not be associated with your {% data variables.product.prodname_dotcom %} account after changing your username.{% endif %} - -> [!WARNING] -> * After a username change, verified commits signed using the previous {% data variables.product.github %}-provided `noreply` email address will lose their "Verified" status. -> * When verifying a signature, {% data variables.product.github %} checks that the email address of the committer or tagger exactly matches one of the email addresses associated with the GPG key's identities. Additionally, {% data variables.product.github %} confirms that the email address is verified and linked to the user's account. This ensures that the key belongs to you and that you created the commit or tag. Because the username of the `noreply` email address changes, these commits can no longer be verified. - -## Your gists - -After changing your username, the URLs to any public or secret gists will also change and previous links to these will return a 404 error. We recommend updating the links to these gists anywhere you may have shared them. - -## CODEOWNERS files - -After changing your username, CODEOWNERS files that include your old username will need to be manually updated. When you view the CODEOWNERS files on {% data variables.product.prodname_dotcom %}, an error message is displayed if the file contains any unknown users, or users without write access. We recommend updating all relevant CODEOWNERS files with your new username. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners). - -## Changing your username - -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.account_settings %} -1. In the "Change username" section, click **Change username**.{% ifversion fpt or ghec %} -1. Read the warnings about changing your username. If you still want to change your username, click **I understand, let's change my username**. -1. Type a new username. -1. If the username you've chosen is available, click **Change my username**. If the username you've chosen is unavailable, you can try a different username or one of the suggestions you see. -{% endif %} - -## Further reading - -* [AUTOTITLE](/pull-requests/committing-changes-to-your-project/troubleshooting-commits/why-are-my-commits-linked-to-the-wrong-user){% ifversion fpt or ghec %} -* [AUTOTITLE](/free-pro-team@latest/site-policy/other-site-policies/github-username-policy){% endif %} diff --git a/content/account-and-profile/concepts/index.md b/content/account-and-profile/concepts/index.md index 19d91b395d2e..5ceb7ce08513 100644 --- a/content/account-and-profile/concepts/index.md +++ b/content/account-and-profile/concepts/index.md @@ -15,8 +15,9 @@ children: - /contributions-visible-on-your-profile - /about-your-organizations-profile - /about-organization-membership - - /changing-your-github-username + - /username-changes - /email-addresses - /scheduled-reminders - /personal-repository-access-and-collaboration --- + diff --git a/content/account-and-profile/concepts/username-changes.md b/content/account-and-profile/concepts/username-changes.md new file mode 100644 index 000000000000..2b2d3daa8618 --- /dev/null +++ b/content/account-and-profile/concepts/username-changes.md @@ -0,0 +1,67 @@ +--- +title: Username changes +intro: You can change the username for your {% data variables.product.github %} account {% ifversion ghes %} if your instance uses built-in authentication{% endif %}. +redirect_from: + - /articles/how-to-change-your-username + - /articles/changing-your-github-user-name + - /articles/renaming-a-user + - /articles/what-happens-when-i-change-my-username + - /articles/changing-your-github-username + - /github/setting-up-and-managing-your-github-user-account/changing-your-github-username + - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/changing-your-github-username + - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/changing-your-github-username + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/changing-your-github-username + - /account-and-profile/concepts/changing-your-github-username +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Accounts + - Usernames +shortTitle: Username changes +contentType: concepts +--- + +## About username changes + +You can change your username to another username that is not currently in use.{% ifversion fpt or ghec %} If the username you want is not available, consider other names or unique variations. Using a number, hyphen, or an alternative spelling might help you find a similar username that's still available. + +After changing your username, your old username becomes available for anyone else to claim. Most references to your repositories under the old username automatically change to the new username. However, some links to your profile won't automatically redirect. + +## Username trademarks + +If you hold a trademark for the username, you can find more information about making a trademark complaint on our [Trademark Policy](/free-pro-team@latest/site-policy/content-removal-policies/github-trademark-policy) page. + +If you do not hold a trademark for the name, you can choose another username or keep your current username. {% data variables.contact.github_support %} cannot release the unavailable username for you.{% endif %} + +## Repository references + +After you change your username, {% data variables.product.github %} will automatically redirect references to your repositories. + +If the new owner of your old username creates a repository with the same name as your repository, that will override the redirect entry and your redirect will stop working. Because of this possibility, we recommend you update all existing remote repository URLs after changing your username. For more information, see [AUTOTITLE](/get-started/git-basics/managing-remote-repositories). + +## Links to your previous profile page + +After changing your username, links to your previous profile page, such as `https://{% data variables.product.product_url %}/previoususername`, will return a 404 error. We recommend updating any links to your profile from elsewhere{% ifversion fpt or ghec %}, such as your LinkedIn or Twitter profile{% endif %}. + +## Accounts logged in on {% data variables.product.prodname_mobile %} + +Accounts logged in on the {% data variables.product.prodname_mobile %} app may continue to display your original username until you log out. To ensure your updated username is displayed, we recommend you sign out and back in to your account on each mobile device. + +## Your Git commits + +If your Git commits are associated with another email address you've added to your {% data variables.product.github %} account, they'll continue to be attributed to you and appear in your contributions graph after you've changed your username. However, some commits using {% data variables.product.github %}-provided email addresses may be affected. For details, see [AUTOTITLE](/account-and-profile/reference/username-reference#git-commits-after-a-username-change). + +## Your gists + +After changing your username, the URLs to any public or secret gists will also change and previous links to these will return a 404 error. We recommend updating the links to these gists anywhere you may have shared them. + +## CODEOWNERS files + +After changing your username, CODEOWNERS files that include your old username will need to be manually updated. When you view the CODEOWNERS files on {% data variables.product.github %}, an error message is displayed if the file contains any unknown users, or users without write access. We recommend updating all relevant CODEOWNERS files with your new username. + +## Next steps + +To change your username, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/changing-your-username). diff --git a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/index.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/index.md index 7c90ee9a5c65..aa03da2a625d 100644 --- a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/index.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/index.md @@ -15,10 +15,10 @@ topics: children: - /showing-an-overview-of-your-activity-on-your-profile - /viewing-contributions-on-your-profile - - /showing-your-private-contributions-and-achievements-on-your-profile + - /manage-visibility-settings-for-private-contributions-and-achievements - /sharing-contributions-from-github-enterprise-server - /troubleshooting-missing-contributions - - /troubleshooting-commits-on-your-timeline + - /viewing-commit-details-from-your-timeline shortTitle: Manage contribution settings --- diff --git a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/manage-visibility-settings-for-private-contributions-and-achievements.md similarity index 50% rename from content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/manage-visibility-settings-for-private-contributions-and-achievements.md index c28e94b8e61b..5218710c5de2 100644 --- a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/manage-visibility-settings-for-private-contributions-and-achievements.md @@ -1,38 +1,26 @@ --- -title: 'Showing your private contributions {% ifversion hide-individual-achievements %}and achievements {% endif %}on your profile' -intro: Your profile shows a graph of your repository contributions over the past year. You can choose to show anonymized activity from private and internal repositories in addition to the activity from public repositories. +title: Manage visibility settings for private contributions {% ifversion hide-individual-achievements %}and achievements {% endif %} +intro: Show anonymized activity from private and internal repositories. redirect_from: - /articles/publicizing-or-hiding-your-private-contributions-on-your-profile - /github/setting-up-and-managing-your-github-profile/publicizing-or-hiding-your-private-contributions-on-your-profile - /github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/publicizing-or-hiding-your-private-contributions-on-your-profile - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/publicizing-or-hiding-your-private-contributions-on-your-profile - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile + - /account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile versions: fpt: '*' ghes: '*' ghec: '*' topics: - Profiles -shortTitle: 'Private contributions {% ifversion hide-individual-achievements %}and achievements{% endif %}' +shortTitle: Private contributions {% ifversion hide-individual-achievements %}and achievements{% endif %} allowTitleToDifferFromFilename: true +contentType: how-tos --- -{% ifversion ghec %} - ->[!NOTE] Achievements are not available on subdomains of {% data variables.enterprise.data_residency_site %}, such as `octocorp.ghe.com`. - -{% endif %} - -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 [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile). - ->[!NOTE] On {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}{% data variables.product.prodname_ghe_server %}{% endif %}, public contributions on your profile are visible {% ifversion fpt or ghec %}to anyone in the world who can access {% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}only to other users of {% data variables.location.product_location %}{% endif %}. - ## Changing the visibility of your private contributions -You can choose to publicize your private contributions, which allows visitors to your profile to see private contribution counts, without further details. - -If you choose to hide your private contributions, visitors will only see your public contributions. - {% data reusables.profile.access_profile %} 1. Above the contribution calendar, click **Contribution settings**. @@ -63,7 +51,6 @@ You can hide an individual achievement on your profile. When hidden, badges are {% endif %} -## Further reading +## Next steps -* [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile) -* [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile) +For more information about contribution visibility, see [AUTOTITLE](/account-and-profile/reference/profile-contributions-reference#who-can-see-your-contributions-and-achievements). diff --git a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server.md index 13c28d672c3b..c369c5f195cc 100644 --- a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server.md @@ -19,15 +19,7 @@ topics: shortTitle: Send enterprise contributions --- -## About enterprise contributions - -When you share contributions, your {% data variables.product.prodname_dotcom_the_website %} or {% data variables.enterprise.data_residency_site %} profile shows {% data variables.product.prodname_ghe_server %} contribution counts from the past 90 days. {% data reusables.github-connect.sync-frequency %} Contribution counts from {% data variables.product.prodname_ghe_server %} are considered private contributions. The commit details will only show the contribution counts and that these contributions were made on {% data variables.product.prodname_ghe_server %}. - -You can decide whether to show counts for private contributions on your profile. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile). - -For more information about how contributions are calculated, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile). - -> [!NOTE] +> [!IMPORTANT] > The connection between your accounts is governed by [GitHub's Privacy Statement](/free-pro-team@latest/site-policy/privacy-policies/github-privacy-statement) and users enabling the connection must agree to the [GitHub Terms of Service](/free-pro-team@latest/site-policy/github-terms/github-terms-of-service). ## Sending your enterprise contributions to your profile @@ -36,7 +28,7 @@ Before you can connect your {% data variables.product.prodname_ghe_server %} pro {% ifversion fpt or ghec %} -To share contributions from {% data variables.product.prodname_ghe_server %}, view this article in the [{% data variables.product.prodname_ghe_server %} version of the site](/enterprise-server@latest/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)." +To share contributions from {% data variables.product.prodname_ghe_server %}, switch to the [{% data variables.product.prodname_ghe_server %} version of this article](/enterprise-server@latest/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile). {% elsif ghes %} diff --git a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md index 95c9ca2e7db0..22199f9c4ca1 100644 --- a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md @@ -16,15 +16,13 @@ topics: shortTitle: Show an overview --- -## About the activity overview - -{% data reusables.profile.activity-overview-summary %} For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile). - -![Screenshot of the activity overview section of a user profile.](/assets/images/help/profile/activity-overview-section.png) - ## Managing the visibility of the activity overview on your profile {% data reusables.profile.access_profile %} 1. Above your contributions graph, select the **Contribution settings** dropdown menu, then click **Activity overview**. ![Screenshot of the contributions graph on a user profile. A dropdown menu, labeled "Contribution settings", is highlighted with an orange outline.](/assets/images/help/profile/activity-overview.png) + +## Next steps + +For more information about what is visible on your profile, see [AUTOTITLE](/account-and-profile/reference/profile-contributions-reference). diff --git a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline.md deleted file mode 100644 index 983698442b63..000000000000 --- a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Troubleshooting commits on your timeline -intro: 'You can view details for commits from your profile''s timeline. If you don''t see commits you expect on your profile or can''t find commit details from your profile page, the commit date and the commit author date may be different.' -redirect_from: - - /articles/troubleshooting-commits-on-your-timeline - - /github/setting-up-and-managing-your-github-profile/troubleshooting-commits-on-your-timeline - - /github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/troubleshooting-commits-on-your-timeline - - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/troubleshooting-commits-on-your-timeline - - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Profiles -shortTitle: Troubleshoot commits ---- - -## Expected behavior to view commit details - -In the "Contribution activity" section of your profile page, you can click the number of commits next to a specific repository to see more details about your commits from that time period, including a diff of specific changes made in a repository. - -![Screenshot of the "Contribution activity" section of a user profile. A link, labeled "29 commits" is highlighted with an orange outline.](/assets/images/help/profile/commit-link-on-profile-timeline.png) - -## Missing commit details from commits in your timeline - -If you click a commit link from your profile page and don't see all of the expected commits on the repository's commits page, then it's possible the commit history in Git was rewritten and the commit author date and the commit date are different. - -## How GitHub uses the Git author date and commit date - -In Git, the author date is when someone first creates a commit with `git commit`. The commit date is identical to the author date unless someone changes the commit date by using `git commit --amend`, a force push, a rebase, or other Git commands. - -On your profile page, the author date is used to calculate when a commit was made. Whereas, in a repository, the commit date is used to calculate when a commit was made in the repository. - -Most often, the author date and commit date are the same but you may notice that your commit sequence is out of order if the commit history is changed. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile) - -## Viewing missing commit details from commits in your timeline - -You can use the `git show` command with the `--pretty=fuller` flag to check if the commit author date and commit date are different. - -```shell -$ git show YOUR_COMMIT_SHA_NUMBER --pretty=fuller -commit YOUR_COMMIT_SHA_NUMBER -Author: octocat USER_EMAIL -AuthorDate: Tue Apr 03 02:02:30 2018 +0900 -Commit: Sally Johnson USER_EMAIL -CommitDate: Tue Apr 10 06:25:08 2018 +0900 -``` - -If the author and commit date are different, you can manually change the commit date in the URL to see the commit details. - -For example: -* This URL uses the author date of `2018-04-03`: - - `https://github.com/your-organization-or-personal-account/your-repository/commits?author=octocat&since=2018-04-03T00:00:00Z&until=2018-04-03T23:59:59Z` -* This URL uses the commit date of `2018-04-10`: - - `https://github.com/your-organization-or-personal-account/your-repository/commits?author=octocat&since=2018-04-10T00:00:00Z&until=2018-04-10T23:59:59Z` - -When you open the URL with the modified commit date, you can see the commit details. - -## Expected commits missing in your timeline - -If you're not seeing expected commits on your timeline, it's possible the commit history in Git was rewritten and the commit author date and the commit date are different. For other possibilities, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile) diff --git a/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-commit-details-from-your-timeline.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-commit-details-from-your-timeline.md new file mode 100644 index 000000000000..9ddea890efab --- /dev/null +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-commit-details-from-your-timeline.md @@ -0,0 +1,58 @@ +--- +title: Viewing commit details from your timeline +intro: You can view details for commits from your profile's timeline. If you don't see commits you expect on your profile or can't find commit details from your profile page, the commit date and the commit author date may be different. +redirect_from: + - /articles/troubleshooting-commits-on-your-timeline + - /github/setting-up-and-managing-your-github-profile/troubleshooting-commits-on-your-timeline + - /github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/troubleshooting-commits-on-your-timeline + - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/troubleshooting-commits-on-your-timeline + - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline + - /account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Profiles +shortTitle: Viewing commit details +contentType: how-tos +--- + +## View commit details + +1. In the "Contribution activity" section of your profile, click the number of commits next to a specific repository. + +![Screenshot of the "Contribution activity" section of a user profile. A link, labeled "29 commits" is highlighted with an orange outline.](/assets/images/help/profile/commit-link-on-profile-timeline.png) + +## Finding missing commits in your timeline + +If you can't find expected commits on your profile, the commit history may have been rewritten, creating different author and commit dates. Follow these steps to locate missing commits: + +1. To check if the author date differs from the commit date, use the `git show` command: + + ```shell + $ git show YOUR_COMMIT_SHA_NUMBER --pretty=fuller + commit YOUR_COMMIT_SHA_NUMBER + Author: octocat USER_EMAIL + AuthorDate: Tue Apr 03 02:02:30 2018 +0900 + Commit: Sally Johnson USER_EMAIL + CommitDate: Tue Apr 10 06:25:08 2018 +0900 + ``` + +1. If the dates differ, modify the GitHub URL to search by the specific date: + + * To search by author date (`2018-04-03`): + + `https://github.com/your-organization-or-personal-account/your-repository/commits?author=octocat&since=2018-04-03T00:00:00Z&until=2018-04-03T23:59:59Z` + + * To search by commit date (`2018-04-10`): + + `https://github.com/your-organization-or-personal-account/your-repository/commits?author=octocat&since=2018-04-10T00:00:00Z&until=2018-04-10T23:59:59Z` + +1. Open the modified URL in your browser to view the commit details. + +## Next steps + +If you're not seeing expected commits on your timeline, it's possible the commit history in Git was rewritten and the commit author date and the commit date are different. For other possibilities, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile). + +For other reference information, see [AUTOTITLE](/account-and-profile/reference/profile-contributions-reference#how-github-uses-the-git-author-date-and-commit-date). diff --git a/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/changing-your-username.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/changing-your-username.md new file mode 100644 index 000000000000..265ed588028f --- /dev/null +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/changing-your-username.md @@ -0,0 +1,31 @@ +--- +title: Changing your username +intro: 'Change your {% data variables.product.github %} username.' +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Accounts + - Usernames +shortTitle: Change username +permissions: '{% ifversion ghec %}Users with personal accounts can change their username. Members of an {% data variables.enterprise.prodname_emu_enterprise %} cannot change their username.{% elsif ghes %}If your instance uses built-in authentication, you can change your username. If you sign in to {% data variables.location.product_location %} with LDAP credentials or single sign-on (SSO), only your local administrator can change your username.{% else %}Users with personal accounts can change their username.{% endif %}' +--- + +## Prerequisites + +Before changing your username, you should be aware of potential impacts on your account and activity. For more information, see [AUTOTITLE](/account-and-profile/concepts/username-changes). + +## Changing your username + +{% data reusables.user-settings.access_settings %} +{% data reusables.user-settings.account_settings %} +1. In the "Change username" section, click **Change username**.{% ifversion fpt or ghec %} +1. Read the warnings about changing your username. If you still want to change your username, click **I understand, let's change my username**. +1. Type a new username. +1. If the username you've chosen is available, click **Change my username**. If the username you've chosen is unavailable, you can try a different username or one of the suggestions you see. +{% endif %} + +## Next steps + +For reference information and limitations, see [AUTOTITLE](/account-and-profile/reference/username-reference#changing-your-username). diff --git a/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md index 614051638335..170004ba71d4 100644 --- a/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md @@ -11,6 +11,7 @@ topics: children: - /managing-multiple-accounts - /merging-multiple-personal-accounts + - /changing-your-username - /converting-a-user-into-an-organization - /unlinking-your-email-address-from-a-locked-account - /deleting-your-personal-account diff --git a/content/account-and-profile/index.md b/content/account-and-profile/index.md index 401c4212027b..e39f45825567 100644 --- a/content/account-and-profile/index.md +++ b/content/account-and-profile/index.md @@ -7,7 +7,7 @@ introLinks: - /get-started/onboarding/getting-started-with-your-github-account featuredLinks: startHere: - - /account-and-profile/concepts/changing-your-github-username + - /account-and-profile/concepts/username-changes - /account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme popular: - /account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address diff --git a/content/account-and-profile/reference/index.md b/content/account-and-profile/reference/index.md index d1afedeb42ba..381235fcb8a7 100644 --- a/content/account-and-profile/reference/index.md +++ b/content/account-and-profile/reference/index.md @@ -14,5 +14,6 @@ children: - /types-of-emails-github-sends - /email-addresses-reference - /personal-account-reference + - /username-reference --- diff --git a/content/account-and-profile/reference/profile-contributions-reference.md b/content/account-and-profile/reference/profile-contributions-reference.md index aaa2c0f3cd36..86ffc4dc5dcc 100644 --- a/content/account-and-profile/reference/profile-contributions-reference.md +++ b/content/account-and-profile/reference/profile-contributions-reference.md @@ -48,6 +48,20 @@ In addition, **at least one** of the following must be true: * You have forked the repository. * You have opened a pull request or issue in the repository. +## Who can see your contributions and achievements + +On {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}{% data variables.product.prodname_ghe_server %}{% endif %}, **public** contributions on your profile are visible {% ifversion fpt or ghec %}to anyone in the world who can access {% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}only to other users of {% data variables.location.product_location %}{% endif %}. + +When you publicize private contributions, people without access to those private repositories will see the number of contributions you made each day. They will not see specific details. + +{% ifversion ghec %} + +### {% data variables.enterprise.data_residency %} + +Achievements are not available on subdomains of {% data variables.enterprise.data_residency_site %}, such as `octocorp.ghe.com`. + +{% endif %} + ## Who receives contribution credit {% ifversion ghes %} @@ -69,3 +83,15 @@ If you merged multiple personal accounts, issues, pull requests, and discussions Timestamps are calculated differently for commits and pull requests: * **Commits** use the time zone information in the commit timestamp. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline). * **Pull requests** and **issues** opened on {% data variables.product.github %} use your browser's time zone. Those opened via the API use the timestamp or time zone [specified in the API call](https://developer.github.com/changes/2014-03-04-timezone-handling-changes). + +## How GitHub uses the Git author date and commit date + +In Git, the author date is when someone first creates a commit with `git commit`. The commit date is identical to the author date unless someone changes the commit date by using `git commit --amend`, a force push, a rebase, or other Git commands. + +On your profile page, the author date is used to calculate when a commit was made. Whereas, in a repository, the commit date is used to calculate when a commit was made in the repository. + +Most often, the author date and commit date are the same but you may notice that your commit sequence is out of order if the commit history is changed. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile). + +## Sharing contributions from {% data variables.product.prodname_ghe_server %} + +When you share contributions, your {% data variables.product.prodname_dotcom_the_website %} or {% data variables.enterprise.data_residency_site %} profile shows {% data variables.product.prodname_ghe_server %} contribution counts from the past 90 days. {% data reusables.github-connect.sync-frequency %} Contribution counts from {% data variables.product.prodname_ghe_server %} are considered private contributions. The commit details will only show the contribution counts and that these contributions were made on {% data variables.product.prodname_ghe_server %}. diff --git a/content/account-and-profile/reference/username-reference.md b/content/account-and-profile/reference/username-reference.md new file mode 100644 index 000000000000..b2dca7dd21b7 --- /dev/null +++ b/content/account-and-profile/reference/username-reference.md @@ -0,0 +1,60 @@ +--- +title: Username reference +shortTitle: Username reference +intro: 'Find information about changing your {% data variables.product.github %} username.' +topics: + - Accounts + - Usernames +versions: + fpt: '*' + ghes: '*' + ghec: '*' +--- + +## Changing your username + +The following list contains limitations and considerations when changing your {% data variables.product.github %} username.{% ifversion fpt or ghec %} For the {% data variables.product.github %} username policy, see [AUTOTITLE](/free-pro-team@latest/site-policy/other-site-policies/github-username-policy){% endif %}. + +### Limitations of username changes + +{% ifversion ghec or ghes %} + +{% ifversion ghec %} + +Members of an {% data variables.enterprise.prodname_emu_enterprise %} cannot change usernames. Your enterprise's IdP administrator controls your {% data variables.product.github %} username. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + +{% elsif ghes %} + +If you sign into {% data variables.location.product_location %} with LDAP credentials or single sign-on (SSO), only your local administrator can change your username. For more information about authentication methods for {% data variables.product.prodname_ghe_server %}, see [AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise). + +{% endif %} + +{% endif %} + +{% ifversion fpt or ghec %} + +{% data reusables.accounts.rename-account-repo-namespace-retirement %} If you try to create a repository using a retired owner name and repository name combination, you will see the error: "The repository `` has been retired and cannot be reused." + +{% endif %} + +{% data reusables.package_registry.rename-account-namespace-retirement %} + +### Repository redirects after username change + +After you change your username, web links to your existing repositories will continue to work. This can take a few minutes to complete after you make the change. + +Command line pushes from your local repository clones to the old remote tracking URLs will continue to work. + +### Redirects for changed usernames + +{% data variables.product.github %} cannot set up redirects for: +* [@mentions](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#mentioning-people-and-teams) using your old username +* Links to [gists](/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists) that include your old username + +### Git commits after a username change + +After a username change, verified commits signed using the previous {% data variables.product.github %}-provided `noreply` email address will lose their "Verified" status. + +When verifying a signature, {% data variables.product.github %} checks that the email address of the committer or tagger exactly matches one of the email addresses associated with the GPG key's identities. Additionally, {% data variables.product.github %} confirms that the email address is verified and linked to the user's account. This ensures that the key belongs to you and that you created the commit or tag. Because the username of the `noreply` email address changes, these commits can no longer be verified. + +{% ifversion fpt or ghec %}If you've been using a {% data variables.product.github %}-provided private commit email address, whether or not your commit history will be retained after an account rename depends on the format of the email address. Git commits that are associated with your {% data variables.product.github %}-provided `noreply` email address won't be attributed to your new username and won't appear in your contributions graph, unless your `noreply` email address is in the form of `ID+USERNAME@users.noreply.github.com`. Older versions of the `noreply` email address that do not contain a numeric ID will not be associated with your {% data variables.product.github %} account after changing your username.{% endif %} diff --git a/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md b/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md index af68db4260ff..d98eb80db93e 100644 --- a/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md +++ b/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md @@ -405,7 +405,7 @@ on: > * {% data reusables.actions.branch-requirement %} > * This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository. -Runs your workflow when a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to cards or columns in a {% data variables.projects.projects_v1_board %}, use the [`project_card`](#project_card) or [`project_column`](#project_column) events instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the {% data variables.projects.projects_v1_board %} APIs, see [AUTOTITLE](/graphql/reference/objects#project) in the GraphQL API documentation or [AUTOTITLE](/rest/projects). +Runs your workflow when a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to cards or columns in a {% data variables.projects.projects_v1_board %}, use the [`project_card`](#project_card) or [`project_column`](#project_column) events instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the {% data variables.projects.projects_v1_board %} APIs, see [AUTOTITLE](/graphql/reference/objects#project) in the GraphQL API documentation or [AUTOTITLE](/rest/projects-classic). For example, you can run a workflow when a project has been `created` or `deleted`. @@ -426,7 +426,7 @@ on: > * {% data reusables.actions.branch-requirement %} > * This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository. -Runs your workflow when a card on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or columns in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_column`](#project_column) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the project card APIs, see [AUTOTITLE](/graphql/reference/objects#projectcard) in the GraphQL API documentation or [AUTOTITLE](/rest/projects/cards). +Runs your workflow when a card on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or columns in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_column`](#project_column) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the project card APIs, see [AUTOTITLE](/graphql/reference/objects#projectcard) in the GraphQL API documentation or [AUTOTITLE](/rest/projects-classic/cards). For example, you can run a workflow when a project card has been `created` or `deleted`. @@ -447,7 +447,7 @@ on: > * {% data reusables.actions.branch-requirement %} > * This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository. -Runs your workflow when a column on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or cards in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_card`](#project_card) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the project column APIs, see [AUTOTITLE](/graphql/reference/objects#projectcolumn) in the GraphQL API documentation or [AUTOTITLE](/rest/projects#columns). +Runs your workflow when a column on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or cards in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_card`](#project_card) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the project column APIs, see [AUTOTITLE](/graphql/reference/objects#projectcolumn) in the GraphQL API documentation or [AUTOTITLE](/rest/projects-classic#columns). For example, you can run a workflow when a project column has been `created` or `deleted`. @@ -1002,7 +1002,7 @@ Notifications for scheduled workflows are sent to the user who last modified the > [!NOTE] > For an enterprise with {% data variables.product.prodname_emus %}, triggering a scheduled workflow requires that the status of the `actor` user account associated with the workflow is currently active (i.e. not suspended or deleted). > * Scheduled workflows will not run if the last `actor` associated with the scheduled workflow has been deprovisioned by the {% data variables.product.prodname_emu %} identity provider (IdP). However, if the last `actor` {% data variables.product.prodname_emu %} has not been deprovisioned by the IdP, and has only been removed as a member from a given organization in the enterprise, scheduled workflows will still run with that user set as the `actor`. -> * Similarly, for an enterprise without {% data variables.product.prodname_emus %}, removing a user from an organization will not prevent scheduled workflows which had that user as their `actor` from running. +> * Similarly, for an enterprise without {% data variables.product.prodname_emus %}, removing a user from an organization will not prevent scheduled workflows which had that user as their `actor` from running. > * Thus, the _user account's_ status, in both {% data variables.product.prodname_emu %} and non-{% data variables.product.prodname_emu %} scenarios, is what's important, _not_ the user's _membership status_ in the organization where the scheduled workflow is located. ## `status` diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md index f38c4b860fd1..8a4b49f63842 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md @@ -25,7 +25,7 @@ If you access {% data variables.product.github %} using other methods, such as t {% else %} -With two-factor authentication enabled, you'll need to provide an authentication code{% ifversion fpt or ghec %}, tap a notification in GitHub Mobile,{% endif %} or use a security key when accessing {% data variables.product.github %} through your browser. If you access {% data variables.product.github %} 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 [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github). +With two-factor authentication enabled, you'll need to provide an authentication code{% ifversion fpt or ghec %}, tap a notification in GitHub Mobile,{% endif %} or use a passkey or security key when accessing {% data variables.product.github %} through your browser. If you access {% data variables.product.github %} 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 [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github). {% endif %} @@ -101,20 +101,12 @@ Enabling 2FA doesn't change how you authenticate to {% data variables.product.gi ## Troubleshooting -If you lose access to your two-factor authentication credentials, you can use your recovery codes or another recovery method (if you've set one up) to regain access to your account. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials). - -{% ifversion fpt or ghec %} - -> [!NOTE] -> {% data reusables.two_fa.unlink-email-address %} - -{% endif %} - -If your authentication fails several times, you may wish to synchronize your phone's clock with your mobile provider. Often, this involves checking the "Set automatically" option on your phone's clock, rather than providing your own time zone. +If you are receiving a "Two-factor authentication failed" error when authenticating with 2FA, the authentication code you are entering is incorrect. You can try troubleshooting your configured authentication methods before attempting account recovery. See [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues). ## Further reading * [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication) * [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication) * [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods) +* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues) * [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials) diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-your-two-factor-authentication-method.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-your-two-factor-authentication-method.md index dd3332073611..7743e6d47385 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-your-two-factor-authentication-method.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-your-two-factor-authentication-method.md @@ -1,6 +1,6 @@ --- title: Changing your two-factor authentication method -intro: You can change two-factor authentication (2FA) method without disabling 2FA entirely. +intro: You can change your two-factor authentication (2FA) method without disabling 2FA entirely. redirect_from: - /articles/changing-two-factor-authentication-delivery-methods - /articles/changing-two-factor-authentication-delivery-methods-for-your-mobile-device diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md index b3125ea10b00..9b91170d27f7 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md @@ -52,7 +52,7 @@ If you're a member of an {% data variables.enterprise.prodname_emu_enterprise %} {% endif %} > [!NOTE] -> You can reconfigure your 2FA settings without disabling 2FA entirely, allowing you to keep both your recovery codes and your membership in organizations that require 2FA. +> You can reconfigure your 2FA settings without disabling 2FA entirely, allowing you to keep both your recovery codes and your membership in organizations that require 2FA. See [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-your-two-factor-authentication-method). ## Configuring two-factor authentication using a TOTP app @@ -141,5 +141,6 @@ After signing in and turning on push notifications, you can now use your device * [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication) * [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods) * [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication) +* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues) * [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials) * [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/index.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/index.md index 6fc5ecbf6599..c83bfe1ed75c 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/index.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/index.md @@ -14,13 +14,14 @@ topics: - 2FA children: - /about-two-factor-authentication + - /about-mandatory-two-factor-authentication - /configuring-two-factor-authentication - /configuring-two-factor-authentication-recovery-methods - /accessing-github-using-two-factor-authentication - - /recovering-your-account-if-you-lose-your-2fa-credentials - - /changing-your-two-factor-authentication-method - - /about-mandatory-two-factor-authentication - /countries-where-sms-authentication-is-supported + - /changing-your-two-factor-authentication-method + - /troubleshooting-two-factor-authentication-issues + - /recovering-your-account-if-you-lose-your-2fa-credentials - /disabling-two-factor-authentication-for-your-personal-account shortTitle: Secure your account with 2FA --- diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md index 6231cc200b80..0a5dbd86fe0a 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md @@ -35,6 +35,9 @@ Use one of your recovery codes to automatically regain entry into your account. {% data reusables.accounts.prompt-for-2fa-recovery-code %} 1. Type one of your recovery codes, then click **Verify**. +> [!NOTE] +> If you are receiving a "Recovery code authentication failed" error when using a recovery code, the code you are entering is invalid. You can try troubleshooting your recovery codes. See [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues). + ## Authenticating with a passkey If you have added a passkey to your account, you can use your passkey to automatically regain access to your account. Passkeys satisfy both password and 2FA requirements, so you don't need to know your password in order to recover your account. See [AUTOTITLE](/authentication/authenticating-with-a-passkey/about-passkeys). @@ -101,4 +104,5 @@ If you have exhausted your recovery options, you can unlink your email address f ## Further reading +* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues) * [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods) diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues.md new file mode 100644 index 000000000000..93243d752ed1 --- /dev/null +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues.md @@ -0,0 +1,100 @@ +--- +title: Troubleshooting two-factor authentication issues +intro: 'If you are having trouble authenticating with 2FA, you can try troubleshooting your configured authentication methods.' +versions: + fpt: '*' + ghec: '*' + ghes: '*' +topics: + - 2FA + - Authentication +shortTitle: Troubleshooting 2FA +--- + +If you are receiving a "Two-factor authentication failed" error when authenticating with two-factor authentication (2FA), the authentication code you are entering is incorrect. You can try troubleshooting your configured authentication methods before attempting account recovery. + +## Troubleshooting authentication using a TOTP app + +### Use the right app + +When authenticating with a TOTP app, {% data variables.product.github %} does not send you anything; you need to provide {% data variables.product.github %} with a valid code, based on the secret key that you saved to your TOTP app when 2FA was set up. Find the app or program that you originally used to setup 2FA and retrieve the authentication code from there. + +### Check your device’s date and time + +TOTP codes are time‑based. If the clock on your phone or computer is out of sync with {% data variables.product.github %}'s server, the code will be invalid. Ensure that your device’s date, time and time zone are set automatically by your network provider. On most mobile devices, this means turning on the **Set automatically** option. + +### Wait for a new code and enter it promptly + +Codes change every 30 seconds. Open your TOTP app, wait for the next code to appear and enter it immediately. Avoid typing spaces or extra characters as these will make the code invalid. + +### Verify you’re using the correct account entry + +Most TOTP apps support multiple accounts for a single website. Make sure you’re reading the code from the correct entry in the app. Codes generated for a different account will not work. + +### Restore from a TOTP backup + +Many TOTP apps support cloud backup or key export. If you lose or reset your device, you may be able restore your 2FA data from the app’s backup to a new device. Consult your app’s documentation for instructions. + +{% ifversion fpt or ghec %} + +## Troubleshooting authentication using text messages + +### Confirm that you can receive text messages + +Make sure your device and cellular plan is capable of receiving Short Message Service (SMS) messages. Some "data-only" phone plans and tablet devices connected to a cellular network may not support receiving text messages. Check with your provider and device manufacturer. + +Carrier rates may apply for received SMS messages. Ensure your cellular plan covers potential charges. + +Disable "Do Not Disturb" mode or spam‑filtering apps that might block receipt of authentication codes. + +### Check that you have cellular coverage + +Receiving text messages generally requires a strong network signal. Ensure you have adequate coverage before requesting an authentication code. + +### Power cycle your phone + +Turning your phone off and on will re-register the device with the network, which may resolve some deliverability issues. Enabling and disabling an "Airplane Mode" may also be sufficient, but power cycling your phone is more reliable. + +### Consult with your cellular provider + +Check with your cellular provider or carrier to see if there are any local outages or delivery issues in your area. They may also be able to investigate delivery issues for your connection. Provide them with the SMS number configured on your {% data variables.product.github %} account and the time that you requested an authentication code from {% data variables.product.github %}. + +> [!NOTE] +> {% data variables.product.github %}, along with our SMS delivery partners, proactively monitors our SMS deliverability success rates. Periods of low-deliverability that would indicate a widespread issue are promptly investigated. You can check active and historical incidents affecting SMS delivery in your region on [{% data variables.product.github %}'s status page](https://githubstatus.com). + +{% endif %} + +## Recovering your account if troubleshooting doesn't help + +If you have tried troubleshooting and you are still having trouble, you can try authenticating with another method, such as a passkey, {% ifversion fpt or ghec %}{% data variables.product.prodname_mobile %},{% endif %} or a security key, if pre-configured on the account. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication). + +{% ifversion fpt or ghec %} + +> [!WARNING] +> For security reasons, {% data variables.contact.github_support %} cannot assist with troubleshooting your 2FA methods, including SMS delivery. + +{% endif %} + +If you don't have another authentication method, you will need to try account recovery. For more information about account recovery, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials). + +## Troubleshooting using recovery codes + +If you are receiving a "Recovery code authentication failed" error when using a recovery code, the code you are entering is invalid. You can try troubleshooting your recovery codes. + +### Use one code at a time + +A set of recovery codes contains more than one code. A single code is 10 alphanumeric characters with a hyphen in the middle: `xxxxx-yyyyy`. + +### Try using a different code + +Each code is single-use only: once it has been used to authenticate, it cannot be used again. Try using a different code from the set. + +### Check you're using the right set of codes + +When 2FA is disabled and re-enabled, a new set of codes are created which invalidates the previous set. Recovery codes are also invalidated whenever a new set of codes is generated. Even if you think you might not have another set of codes, you could try searching for them in your devices, backups, and password managers. They will have the default filename `github-recovery-codes.txt`. + +## Further reading + +* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication) +* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication) +* [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials) diff --git a/content/billing/concepts/billing-cycles.md b/content/billing/concepts/billing-cycles.md index 19e89951c8f4..ed45c77463ed 100644 --- a/content/billing/concepts/billing-cycles.md +++ b/content/billing/concepts/billing-cycles.md @@ -26,7 +26,7 @@ Your billing experience depends on whether your products are metered, volume-bas ## Billing cycles for metered products -Metered products have a fixed **billing period** that runs from the first day of each month to the last day of the month. +Metered products have a fixed **billing period** that starts at 00:00:00 UTC on the first day of each month and ends at 23:59:59 UTC on the last day of the month. At the end of each month, your metered usage is calculated and scheduled to be billed on your **bill cycle day**. diff --git a/content/billing/reference/usage-reports.md b/content/billing/reference/usage-reports.md index 224b0a7da76c..c17ed812a077 100644 --- a/content/billing/reference/usage-reports.md +++ b/content/billing/reference/usage-reports.md @@ -69,4 +69,4 @@ The usage report contains the following fields. ## Receiving the report -Usage reports are sent via email to the default email address associated with your {% data variables.product.github %} account. +Usage reports are sent via email to the default email address associated with your {% data variables.product.github %} account. You can only request one usage report per account at a time. diff --git a/content/copilot/how-tos/use-ai-models/change-the-chat-model.md b/content/copilot/how-tos/use-ai-models/change-the-chat-model.md index aa1d180d15e0..b73c0e3d0dd5 100644 --- a/content/copilot/how-tos/use-ai-models/change-the-chat-model.md +++ b/content/copilot/how-tos/use-ai-models/change-the-chat-model.md @@ -61,7 +61,47 @@ These instructions are for {% data variables.product.prodname_vscode %}. For ins {% data reusables.copilot.chat-model-limitations-ide %} {% data reusables.copilot.open-chat-vs-code %} -1. In the bottom right of the chat view, select the **CURRENT-MODEL** {% octicon "chevron-down" aria-hidden="true" aria-label="chevron-down" %} dropdown menu, then click the AI model of your choice. +1. At the bottom of the chat view, select the **CURRENT-MODEL** {% octicon "chevron-down" aria-hidden="true" aria-label="chevron-down" %} dropdown menu, then click the AI model of your choice. + +## Adding more models + +You can expand the model options that are available to power {% data variables.copilot.copilot_chat_short %}. You can add models from: + +* **A model provider**—such as Anthropic, Gemini, OpenAI, and others. +* **The AI Toolkit for {% data variables.product.prodname_vscode %}**. + +> [!NOTE] Using the AI Toolkit for {% data variables.product.prodname_vscode_shortname %} is in {% data variables.release-phases.public_preview %} and subject to change. + +### Prerequisites + +* Depending on the provider or model you choose, you may need to supply an API key, or model ID, from the provider, or a {% data variables.product.github %} {% data variables.product.pat_generic %} (PAT). +* To add models from the AI Toolkit for {% data variables.product.prodname_vscode %}, you must install the AI Toolkit extension. + +### Adding models + +1. In the {% data variables.product.prodname_copilot_short %} chat view, click the **CURRENT-MODEL** {% octicon "chevron-down" aria-hidden="true" aria-label="chevron-down" %} dropdown menu. +1. Click **Manage Models**. + + ![Screenshot of the 'Manage Models' option, highlighted with a dark orange outline.](/assets/images/help/copilot/vsc-manage-models-option.png) + + A list of providers is displayed. + + If you have installed the AI Toolkit, then additional providers, added via the AI Toolkit, are also listed. + + ![Screenshot of the 'Manage Language Models' list.](/assets/images/help/copilot/vsc-manage-models-list.png) + +1. Click the provider whose model(s) you want to add. +1. Depending on which provider you selected, you may be prompted to enter a {% data variables.product.github %} PAT, an API key for the provider, or a model ID for a specific model. + + Enter the required information, then press Enter. + + A list of available models is displayed. + +1. Select the model(s) you want to add, then click **OK**. + +The models you selected are now available in the model picker in the chat view. + +If you added a model from a provider via the AI Toolkit then the first time you use the model, you will be prompted to download it. You may also be prompted to authenticate with the provider. > [!TIP] If you're already using chat with {% data variables.copilot.copilot_auto_model_selection_short %}, you'll need to start a new chat session to switch models. To start a new session, in the top right of the chat view, click {% octicon "plus" aria-label="new chat" %} new chat. @@ -137,3 +177,9 @@ To use multi-model {% data variables.copilot.copilot_chat_short %}, you must ins * [AUTOTITLE](/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-code-completion) * [AUTOTITLE](/copilot/reference/ai-models/model-comparison) + +{% vscode %} + +* [AI language models in VS Code](https://code.visualstudio.com/docs/copilot/language-models#_bring-your-own-language-model-key) in the {% data variables.product.prodname_vscode %} documentation. + +{% endvscode %} diff --git a/content/copilot/reference/ai-models/supported-models.md b/content/copilot/reference/ai-models/supported-models.md index fa988d550591..e152ddca4e10 100644 --- a/content/copilot/reference/ai-models/supported-models.md +++ b/content/copilot/reference/ai-models/supported-models.md @@ -25,9 +25,11 @@ contentType: reference Depending on your {% data variables.product.prodname_copilot_short %} plan and where you're using it—such as {% data variables.product.prodname_dotcom_the_website %} or an IDE—you may have access to different models. ->[!NOTE] Model availability is subject to change. Some models may be replaced or updated over time. +> [!NOTE] +> * Model availability is subject to change. Some models may be replaced or updated over time. +> * In {% data variables.product.prodname_vscode %} you can add more models than those that are available by default with your {% data variables.product.prodname_copilot_short %} subscription. See [AUTOTITLE](/copilot/how-tos/use-ai-models/change-the-chat-model?tool=vscode#adding-more-models). -For all AI models, input prompts and output completions run through {% data variables.product.prodname_copilot %}'s content filters for harmful, offensive, or off-topic content, and for public code matching when enabled. +For all of the default AI models, input prompts and output completions run through {% data variables.product.prodname_copilot %}'s content filters for harmful, offensive, or off-topic content, and for public code matching when enabled. ## Supported AI models in {% data variables.product.prodname_copilot_short %} diff --git a/content/rest/index.md b/content/rest/index.md index f1ab02711330..8dccb34e8d48 100644 --- a/content/rest/index.md +++ b/content/rest/index.md @@ -23,7 +23,7 @@ featuredLinks: - /rest/guides/using-the-rest-api-to-interact-with-checks - /rest/using-the-rest-api/using-pagination-in-the-rest-api changelog: - label: 'api, apis' + label: api, apis layout: product-landing redirect_from: - /v3 @@ -79,6 +79,7 @@ children: - /packages - /pages - /private-registries + - /projects - /projects-classic - /pulls - /rate-limit diff --git a/content/rest/projects-classic/index.md b/content/rest/projects-classic/index.md index 883e6b85813e..97b1f4c2edea 100644 --- a/content/rest/projects-classic/index.md +++ b/content/rest/projects-classic/index.md @@ -5,7 +5,6 @@ intro: 'Use the REST API to create, list, update, delete and customize {% data v redirect_from: - /v3/projects - /rest/reference/projects - - /rest/projects topics: - API autogenerated: rest diff --git a/content/rest/projects-classic/projects.md b/content/rest/projects-classic/projects.md index 735d4359a91c..a25879632b3d 100644 --- a/content/rest/projects-classic/projects.md +++ b/content/rest/projects-classic/projects.md @@ -13,7 +13,6 @@ topics: - API autogenerated: rest redirect_from: - - /rest/projects/projects - /v3/projects/projects - /rest/reference/projects/projects --- diff --git a/content/rest/projects/fields.md b/content/rest/projects/fields.md new file mode 100644 index 000000000000..80ab225c7f0a --- /dev/null +++ b/content/rest/projects/fields.md @@ -0,0 +1,14 @@ +--- +title: REST API endpoints for Project fields +shortTitle: Project fields +intro: Use the REST API to manage Project fields +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + + diff --git a/content/rest/projects/index.md b/content/rest/projects/index.md new file mode 100644 index 000000000000..fa72cfcbe8e0 --- /dev/null +++ b/content/rest/projects/index.md @@ -0,0 +1,15 @@ +--- +title: Projects +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +children: + - /fields + - /items + - /projects +versions: + fpt: '*' + ghec: '*' +--- + diff --git a/content/rest/projects/items.md b/content/rest/projects/items.md new file mode 100644 index 000000000000..ac308d203fc9 --- /dev/null +++ b/content/rest/projects/items.md @@ -0,0 +1,14 @@ +--- +title: REST API endpoints for Project items +shortTitle: Project items +intro: Use the REST API to manage Project items +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + + diff --git a/content/rest/projects/projects.md b/content/rest/projects/projects.md new file mode 100644 index 000000000000..4043bfec3f5d --- /dev/null +++ b/content/rest/projects/projects.md @@ -0,0 +1,14 @@ +--- +title: REST API endpoints for Projects +shortTitle: Projects +intro: Use the REST API to manage Projects +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + + diff --git a/data/reusables/accounts/prompt-for-2fa-recovery-code.md b/data/reusables/accounts/prompt-for-2fa-recovery-code.md index 8591c32d5d3e..87bafd91013b 100644 --- a/data/reusables/accounts/prompt-for-2fa-recovery-code.md +++ b/data/reusables/accounts/prompt-for-2fa-recovery-code.md @@ -1,5 +1,9 @@ -1. Navigate to [https://github.com/login](https://github.com/login). +1. Navigate to {% data variables.product.login_url %}. 1. To prompt two-factor authentication, type your username and password, then click **Sign in**. +{% ifversion fpt or ghec %} + > [!NOTE] - > If you have linked a Google account to your {% data variables.product.prodname_dotcom %} account, you can sign-in with your social login instead of using your password. + > If you have linked a social account to your {% data variables.product.github %} account, you can sign-in with your social login instead of using your password. + +{% endif %} 1. Under "More options", click **2FA recovery code**. diff --git a/data/reusables/copilot/editor-preview-settings.md b/data/reusables/copilot/editor-preview-settings.md index 2ab1fe68773d..d048c77e0566 100644 --- a/data/reusables/copilot/editor-preview-settings.md +++ b/data/reusables/copilot/editor-preview-settings.md @@ -1 +1 @@ -If you're using a {% data variables.copilot.copilot_business_short %}{% ifversion ghec %} or {% data variables.copilot.copilot_enterprise_short %}{% endif %} plan, the organization{% ifversion ghec %} or enterprise{% endif %} that provides your plan must enable the **Editor preview features** setting. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization){% ifversion ghec %} or [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#configuring-policies-for-github-copilot){% endif %}. +If you're using a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan, the organization or enterprise that provides your plan must enable the **Editor preview features** setting. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization) or [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#configuring-policies-for-github-copilot). diff --git a/data/reusables/two_fa/support-may-not-help.md b/data/reusables/two_fa/support-may-not-help.md index d984c705ea41..a0106095d576 100644 --- a/data/reusables/two_fa/support-may-not-help.md +++ b/data/reusables/two_fa/support-may-not-help.md @@ -1 +1 @@ -For security reasons, {% data variables.product.company_short %} Support [will not be able to restore access to accounts](/free-pro-team@latest/site-policy/other-site-policies/github-account-recovery-policy) with two-factor authentication enabled if you lose your two-factor authentication credentials or lose access to your account recovery methods. +For security reasons, {% data variables.contact.github_support %} [will not be able to restore access to accounts](/free-pro-team@latest/site-policy/other-site-policies/github-account-recovery-policy) with two-factor authentication enabled if you lose your two-factor authentication credentials or lose access to your account recovery methods. diff --git a/data/variables/product.yml b/data/variables/product.yml index e4f9ead6a7fd..bf0c3c3bc360 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -237,7 +237,7 @@ prodname_learning_link: 'https://skills.github.com/' prodname_roadmap: 'GitHub public roadmap' prodname_roadmap_link: 'https://github.com/github/roadmap#github-public-roadmap' -# GitHub support +# GitHub Support plans standard_support_plan: 'Standard plan' premium_support_plan: 'Premium plan' premium_plus_support_plan: 'Premium Plus plan / GitHub Engineering Direct' @@ -334,6 +334,12 @@ pricing_url: 'https://github.com/pricing' pricing_link: '[GitHub Pricing](https://github.com/pricing)' raw_github_com: >- {% ifversion fpt or ghec %}raw.githubusercontent.com{% else %}HOSTNAME/user/repo/raw{% endif %} +login_url: >- + {%- ifversion fpt or ghec %} + [`https://github.com/login`](https://github.com/login) + {%- elsif ghes %} + `http(s)://HOSTNAME/login` + {%- endif %} # GitHub Enterprise Server past versions current-340-version: '11.10.354' diff --git a/package.json b/package.json index b5c18f05d11c..6de1c29682be 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,7 @@ "cmp-files": "tsx src/workflows/cmp-files.ts", "content-changes-table-comment": "tsx src/workflows/content-changes-table-comment.ts", "copy-fixture-data": "tsx src/tests/scripts/copy-fixture-data.ts", - "count-translation-corruptions": "tsx src/languages/scripts/count-translation-corruptions.ts", + "count-translation-corruptions": "cross-env NODE_OPTIONS=--max-old-space-size=8192 tsx src/languages/scripts/count-translation-corruptions.ts", "create-enterprise-issue": "tsx src/ghes-releases/scripts/create-enterprise-issue.ts", "debug": "cross-env NODE_ENV=development ENABLED_LANGUAGES=en nodemon --inspect src/frame/server.ts", "delete-orphan-translation-files": "tsx src/workflows/delete-orphan-translation-files.ts", diff --git a/src/frame/lib/frontmatter.js b/src/frame/lib/frontmatter.js index ca99e44ffce9..9de39a7ac389 100644 --- a/src/frame/lib/frontmatter.js +++ b/src/frame/lib/frontmatter.js @@ -202,6 +202,10 @@ export const schema = { product_video_transcript: { type: 'string', }, + // Hero image for landing pages + heroImage: { + type: 'string', + }, interactive: { type: 'boolean', }, diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json index 67ef873a6024..74d5560d37d0 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json @@ -2133,6 +2133,87 @@ "additional-permissions": false, "access": "write" }, + { + "category": "projects", + "slug": "list-projects-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects", + "slug": "get-project-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects", + "slug": "list-project-fields-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects", + "slug": "get-project-field-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects", + "slug": "list-items-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects", + "slug": "add-item-to-organization-owned-project", + "subcategory": "items", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items", + "additional-permissions": false, + "access": "write" + }, + { + "category": "projects", + "slug": "get-an-item-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects", + "slug": "update-project-item-for-organization", + "subcategory": "items", + "verb": "patch", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "projects", + "slug": "delete-project-item-for-organization", + "subcategory": "items", + "verb": "delete", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "additional-permissions": false, + "access": "write" + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index fd07b76c10dd..d7c5f158fbbe 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -3653,6 +3653,62 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects": [ + { + "slug": "list-projects-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2" + }, + { + "slug": "get-project-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}" + }, + { + "slug": "list-project-fields-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields" + }, + { + "slug": "get-project-field-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}" + }, + { + "slug": "list-items-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items" + }, + { + "slug": "add-item-to-organization-owned-project", + "subcategory": "items", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items" + }, + { + "slug": "get-an-item-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + }, + { + "slug": "update-project-item-for-organization", + "subcategory": "items", + "verb": "patch", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + }, + { + "slug": "delete-project-item-for-organization", + "subcategory": "items", + "verb": "delete", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + } + ], "projects-classic": [ { "slug": "list-organization-projects", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json index cf48a73f15cb..6307a3699961 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json @@ -2685,6 +2685,105 @@ "server-to-server": true, "additional-permissions": false }, + { + "category": "projects", + "slug": "list-projects-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "get-project-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "list-project-fields-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "get-project-field-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "list-items-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "add-item-to-organization-owned-project", + "subcategory": "items", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "get-an-item-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "update-project-item-for-organization", + "subcategory": "items", + "verb": "patch", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "delete-project-item-for-organization", + "subcategory": "items", + "verb": "delete", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index 12c04c998361..3d4f16446107 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -3747,6 +3747,62 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects": [ + { + "slug": "list-projects-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2" + }, + { + "slug": "get-project-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}" + }, + { + "slug": "list-project-fields-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields" + }, + { + "slug": "get-project-field-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}" + }, + { + "slug": "list-items-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items" + }, + { + "slug": "add-item-to-organization-owned-project", + "subcategory": "items", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items" + }, + { + "slug": "get-an-item-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + }, + { + "slug": "update-project-item-for-organization", + "subcategory": "items", + "verb": "patch", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + }, + { + "slug": "delete-project-item-for-organization", + "subcategory": "items", + "verb": "delete", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + } + ], "projects-classic": [ { "slug": "list-organization-projects", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index 4b66034c86fe..607762fac6ec 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -4215,6 +4215,62 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects": [ + { + "slug": "list-projects-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2" + }, + { + "slug": "get-project-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}" + }, + { + "slug": "list-project-fields-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields" + }, + { + "slug": "get-project-field-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}" + }, + { + "slug": "list-items-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items" + }, + { + "slug": "add-item-to-organization-owned-project", + "subcategory": "items", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items" + }, + { + "slug": "get-an-item-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + }, + { + "slug": "update-project-item-for-organization", + "subcategory": "items", + "verb": "patch", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + }, + { + "slug": "delete-project-item-for-organization", + "subcategory": "items", + "verb": "delete", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + } + ], "projects-classic": [ { "slug": "list-organization-projects", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index 7bf97e0ba1cd..62d97266e55e 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -2826,6 +2826,87 @@ "additional-permissions": false, "access": "write" }, + { + "category": "projects", + "slug": "list-projects-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects", + "slug": "get-project-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects", + "slug": "list-project-fields-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects", + "slug": "get-project-field-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects", + "slug": "list-items-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects", + "slug": "add-item-to-organization-owned-project", + "subcategory": "items", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items", + "additional-permissions": false, + "access": "write" + }, + { + "category": "projects", + "slug": "get-an-item-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects", + "slug": "update-project-item-for-organization", + "subcategory": "items", + "verb": "patch", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "projects", + "slug": "delete-project-item-for-organization", + "subcategory": "items", + "verb": "delete", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "additional-permissions": false, + "access": "write" + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index e494d9aa6d3a..b12b697c99be 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -4017,6 +4017,62 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects": [ + { + "slug": "list-projects-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2" + }, + { + "slug": "get-project-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}" + }, + { + "slug": "list-project-fields-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields" + }, + { + "slug": "get-project-field-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}" + }, + { + "slug": "list-items-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items" + }, + { + "slug": "add-item-to-organization-owned-project", + "subcategory": "items", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items" + }, + { + "slug": "get-an-item-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + }, + { + "slug": "update-project-item-for-organization", + "subcategory": "items", + "verb": "patch", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + }, + { + "slug": "delete-project-item-for-organization", + "subcategory": "items", + "verb": "delete", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + } + ], "projects-classic": [ { "slug": "list-organization-projects", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index bb347dc962c4..d810ca9e4b05 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -3690,6 +3690,105 @@ "server-to-server": true, "additional-permissions": false }, + { + "category": "projects", + "slug": "list-projects-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "get-project-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "list-project-fields-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "get-project-field-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "list-items-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "add-item-to-organization-owned-project", + "subcategory": "items", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "get-an-item-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "update-project-item-for-organization", + "subcategory": "items", + "verb": "patch", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects", + "slug": "delete-project-item-for-organization", + "subcategory": "items", + "verb": "delete", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index a678682e7c2f..87a0215e9f4d 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -4165,6 +4165,62 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects": [ + { + "slug": "list-projects-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2" + }, + { + "slug": "get-project-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}" + }, + { + "slug": "list-project-fields-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields" + }, + { + "slug": "get-project-field-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}" + }, + { + "slug": "list-items-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items" + }, + { + "slug": "add-item-to-organization-owned-project", + "subcategory": "items", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items" + }, + { + "slug": "get-an-item-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + }, + { + "slug": "update-project-item-for-organization", + "subcategory": "items", + "verb": "patch", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + }, + { + "slug": "delete-project-item-for-organization", + "subcategory": "items", + "verb": "delete", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + } + ], "projects-classic": [ { "slug": "list-organization-projects", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index 86ed1f2592d9..1f561cb65928 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -4633,6 +4633,62 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects": [ + { + "slug": "list-projects-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2" + }, + { + "slug": "get-project-for-organization", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}" + }, + { + "slug": "list-project-fields-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields" + }, + { + "slug": "get-project-field-for-organization", + "subcategory": "fields", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}" + }, + { + "slug": "list-items-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items" + }, + { + "slug": "add-item-to-organization-owned-project", + "subcategory": "items", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items" + }, + { + "slug": "get-an-item-for-an-organization-owned-project", + "subcategory": "items", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + }, + { + "slug": "update-project-item-for-organization", + "subcategory": "items", + "verb": "patch", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + }, + { + "slug": "delete-project-item-for-organization", + "subcategory": "items", + "verb": "delete", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}" + } + ], "projects-classic": [ { "slug": "list-organization-projects", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 929bb1253b57..e04f994dfa09 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "f0dc156505ef3ea9ae0fd2f227aca5642c465e4f" + "sha": "e605333115d5123d2ac50baf757e65cbb94a60c3" } \ No newline at end of file diff --git a/src/graphql/data/fpt/changelog.json b/src/graphql/data/fpt/changelog.json index 6f7918d549f6..0a55e6d9f41c 100644 --- a/src/graphql/data/fpt/changelog.json +++ b/src/graphql/data/fpt/changelog.json @@ -1,4 +1,23 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "

Field viewerCanUnminimize was added to object type CommitComment

", + "

Field viewerCanUnminimize was added to object type DiscussionComment

", + "

Field viewerCanUnminimize was added to object type GistComment

", + "

Field viewerCanUnminimize was added to object type IssueComment

", + "

Field viewerCanUnminimize was added to interface Minimizable

", + "

Field viewerCanUnminimize was added to object type PullRequestReview

", + "

Field viewerCanUnminimize was added to object type PullRequestReviewComment

" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2025-09-11" + }, { "schemaChanges": [ { diff --git a/src/graphql/data/fpt/schema.docs.graphql b/src/graphql/data/fpt/schema.docs.graphql index f7234dcc468d..3eb3438c79f9 100644 --- a/src/graphql/data/fpt/schema.docs.graphql +++ b/src/graphql/data/fpt/schema.docs.graphql @@ -5849,6 +5849,11 @@ type CommitComment implements Comment & Deletable & Minimizable & Node & Reactab """ viewerCanReact: Boolean! + """ + Check if the current viewer can unminimize this object. + """ + viewerCanUnminimize: Boolean! + """ Check if the current viewer can update this object. """ @@ -12604,6 +12609,11 @@ type DiscussionComment implements Comment & Deletable & Minimizable & Node & Rea """ viewerCanUnmarkAsAnswer: Boolean! + """ + Check if the current viewer can unminimize this object. + """ + viewerCanUnminimize: Boolean! + """ Check if the current viewer can update this object. """ @@ -17601,6 +17611,11 @@ type GistComment implements Comment & Deletable & Minimizable & Node & Updatable """ viewerCanMinimize: Boolean! + """ + Check if the current viewer can unminimize this object. + """ + viewerCanUnminimize: Boolean! + """ Check if the current viewer can update this object. """ @@ -19804,6 +19819,11 @@ type IssueComment implements Comment & Deletable & Minimizable & Node & Reactabl """ viewerCanReact: Boolean! + """ + Check if the current viewer can unminimize this object. + """ + viewerCanUnminimize: Boolean! + """ Check if the current viewer can update this object. """ @@ -24126,6 +24146,11 @@ interface Minimizable { Check if the current viewer can minimize this object. """ viewerCanMinimize: Boolean! + + """ + Check if the current viewer can unminimize this object. + """ + viewerCanUnminimize: Boolean! } """ @@ -41942,6 +41967,11 @@ type PullRequestReview implements Comment & Deletable & Minimizable & Node & Rea """ viewerCanReact: Boolean! + """ + Check if the current viewer can unminimize this object. + """ + viewerCanUnminimize: Boolean! + """ Check if the current viewer can update this object. """ @@ -42236,6 +42266,11 @@ type PullRequestReviewComment implements Comment & Deletable & Minimizable & Nod """ viewerCanReact: Boolean! + """ + Check if the current viewer can unminimize this object. + """ + viewerCanUnminimize: Boolean! + """ Check if the current viewer can update this object. """ diff --git a/src/graphql/data/fpt/schema.json b/src/graphql/data/fpt/schema.json index 456d96c7e4ff..2248cff542e7 100644 --- a/src/graphql/data/fpt/schema.json +++ b/src/graphql/data/fpt/schema.json @@ -15541,6 +15541,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "viewerCanUnminimize", + "description": "

Check if the current viewer can unminimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "viewerCanUpdate", "description": "

Check if the current viewer can update this object.

", @@ -21293,6 +21301,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "viewerCanUnminimize", + "description": "

Check if the current viewer can unminimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "viewerCanUpdate", "description": "

Check if the current viewer can update this object.

", @@ -28164,6 +28180,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "viewerCanUnminimize", + "description": "

Check if the current viewer can unminimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "viewerCanUpdate", "description": "

Check if the current viewer can update this object.

", @@ -31178,6 +31202,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "viewerCanUnminimize", + "description": "

Check if the current viewer can unminimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "viewerCanUpdate", "description": "

Check if the current viewer can update this object.

", @@ -56352,6 +56384,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "viewerCanUnminimize", + "description": "

Check if the current viewer can unminimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "viewerCanUpdate", "description": "

Check if the current viewer can update this object.

", @@ -56881,6 +56921,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "viewerCanUnminimize", + "description": "

Check if the current viewer can unminimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "viewerCanUpdate", "description": "

Check if the current viewer can update this object.

", @@ -85459,6 +85507,14 @@ "id": "boolean", "kind": "scalars", "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerCanUnminimize", + "description": "

Check if the current viewer can unminimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" } ] }, diff --git a/src/graphql/data/ghec/schema.docs.graphql b/src/graphql/data/ghec/schema.docs.graphql index f7234dcc468d..3eb3438c79f9 100644 --- a/src/graphql/data/ghec/schema.docs.graphql +++ b/src/graphql/data/ghec/schema.docs.graphql @@ -5849,6 +5849,11 @@ type CommitComment implements Comment & Deletable & Minimizable & Node & Reactab """ viewerCanReact: Boolean! + """ + Check if the current viewer can unminimize this object. + """ + viewerCanUnminimize: Boolean! + """ Check if the current viewer can update this object. """ @@ -12604,6 +12609,11 @@ type DiscussionComment implements Comment & Deletable & Minimizable & Node & Rea """ viewerCanUnmarkAsAnswer: Boolean! + """ + Check if the current viewer can unminimize this object. + """ + viewerCanUnminimize: Boolean! + """ Check if the current viewer can update this object. """ @@ -17601,6 +17611,11 @@ type GistComment implements Comment & Deletable & Minimizable & Node & Updatable """ viewerCanMinimize: Boolean! + """ + Check if the current viewer can unminimize this object. + """ + viewerCanUnminimize: Boolean! + """ Check if the current viewer can update this object. """ @@ -19804,6 +19819,11 @@ type IssueComment implements Comment & Deletable & Minimizable & Node & Reactabl """ viewerCanReact: Boolean! + """ + Check if the current viewer can unminimize this object. + """ + viewerCanUnminimize: Boolean! + """ Check if the current viewer can update this object. """ @@ -24126,6 +24146,11 @@ interface Minimizable { Check if the current viewer can minimize this object. """ viewerCanMinimize: Boolean! + + """ + Check if the current viewer can unminimize this object. + """ + viewerCanUnminimize: Boolean! } """ @@ -41942,6 +41967,11 @@ type PullRequestReview implements Comment & Deletable & Minimizable & Node & Rea """ viewerCanReact: Boolean! + """ + Check if the current viewer can unminimize this object. + """ + viewerCanUnminimize: Boolean! + """ Check if the current viewer can update this object. """ @@ -42236,6 +42266,11 @@ type PullRequestReviewComment implements Comment & Deletable & Minimizable & Nod """ viewerCanReact: Boolean! + """ + Check if the current viewer can unminimize this object. + """ + viewerCanUnminimize: Boolean! + """ Check if the current viewer can update this object. """ diff --git a/src/graphql/data/ghec/schema.json b/src/graphql/data/ghec/schema.json index 456d96c7e4ff..2248cff542e7 100644 --- a/src/graphql/data/ghec/schema.json +++ b/src/graphql/data/ghec/schema.json @@ -15541,6 +15541,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "viewerCanUnminimize", + "description": "

Check if the current viewer can unminimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "viewerCanUpdate", "description": "

Check if the current viewer can update this object.

", @@ -21293,6 +21301,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "viewerCanUnminimize", + "description": "

Check if the current viewer can unminimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "viewerCanUpdate", "description": "

Check if the current viewer can update this object.

", @@ -28164,6 +28180,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "viewerCanUnminimize", + "description": "

Check if the current viewer can unminimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "viewerCanUpdate", "description": "

Check if the current viewer can update this object.

", @@ -31178,6 +31202,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "viewerCanUnminimize", + "description": "

Check if the current viewer can unminimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "viewerCanUpdate", "description": "

Check if the current viewer can update this object.

", @@ -56352,6 +56384,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "viewerCanUnminimize", + "description": "

Check if the current viewer can unminimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "viewerCanUpdate", "description": "

Check if the current viewer can update this object.

", @@ -56881,6 +56921,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "viewerCanUnminimize", + "description": "

Check if the current viewer can unminimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "viewerCanUpdate", "description": "

Check if the current viewer can update this object.

", @@ -85459,6 +85507,14 @@ "id": "boolean", "kind": "scalars", "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "viewerCanUnminimize", + "description": "

Check if the current viewer can unminimize this object.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" } ] }, diff --git a/src/landings/components/ProductLandingContext.tsx b/src/landings/components/ProductLandingContext.tsx index deecd64572e7..f732228e93da 100644 --- a/src/landings/components/ProductLandingContext.tsx +++ b/src/landings/components/ProductLandingContext.tsx @@ -39,6 +39,7 @@ export type ProductLandingContextT = { introLinks: Record | null productVideo: string productVideoTranscript: string + heroImage?: string featuredLinks: Record> productUserExamples: Array<{ username: string; description: string }> productCommunityExamples: Array<{ repo: string; description: string }> @@ -113,6 +114,7 @@ export const getProductLandingContextFromRequest = async ( ...pick(page, ['introPlainText', 'beta_product', 'intro']), productVideo, productVideoTranscript: page.product_video_transcript || null, + heroImage: page.heroImage || null, hasGuidesPage, product: { href: productTree.href, diff --git a/src/landings/components/bespoke/BespokeLanding.tsx b/src/landings/components/bespoke/BespokeLanding.tsx index 29746737c2dc..0e61f7bf561f 100644 --- a/src/landings/components/bespoke/BespokeLanding.tsx +++ b/src/landings/components/bespoke/BespokeLanding.tsx @@ -1,14 +1,14 @@ import { useMemo } from 'react' import { DefaultLayout } from '@/frame/components/DefaultLayout' -import { useBespokeContext } from '@/landings/context/BespokeContext' +import { useLandingContext } from '@/landings/context/LandingContext' import { LandingHero } from '@/landings/components/shared/LandingHero' import { ArticleGrid } from '@/landings/components/shared/LandingArticleGridWithFilter' import type { ArticleCardItems } from '@/landings/types' export const BespokeLanding = () => { - const { title, intro, tocItems } = useBespokeContext() + const { title, intro, heroImage, introLinks, tocItems } = useLandingContext() const flatArticles: ArticleCardItems = useMemo( () => tocItems.flatMap((item) => item.childTocItems || []), @@ -18,7 +18,7 @@ export const BespokeLanding = () => { return (
- +
diff --git a/src/landings/components/discovery/DiscoveryLanding.tsx b/src/landings/components/discovery/DiscoveryLanding.tsx index 4bd247378cf5..61c87ba0b883 100644 --- a/src/landings/components/discovery/DiscoveryLanding.tsx +++ b/src/landings/components/discovery/DiscoveryLanding.tsx @@ -1,7 +1,7 @@ import { useMemo } from 'react' import { DefaultLayout } from '@/frame/components/DefaultLayout' -import { useDiscoveryContext } from '@/landings/context/DiscoveryContext' +import { useLandingContext } from '@/landings/context/LandingContext' import { LandingHero } from '@/landings/components/shared/LandingHero' import { ArticleGrid } from '@/landings/components/shared/LandingArticleGridWithFilter' import { LandingCarousel } from '@/landings/components/shared/LandingCarousel' @@ -9,7 +9,7 @@ import { LandingCarousel } from '@/landings/components/shared/LandingCarousel' import type { ArticleCardItems } from '@/landings/types' export const DiscoveryLanding = () => { - const { title, intro, tocItems, recommended } = useDiscoveryContext() + const { title, intro, heroImage, introLinks, tocItems, recommended } = useLandingContext() const flatArticles: ArticleCardItems = useMemo( () => tocItems.flatMap((item) => item.childTocItems || []), @@ -19,7 +19,7 @@ export const DiscoveryLanding = () => { return (
- +
diff --git a/src/landings/components/journey/JourneyLanding.tsx b/src/landings/components/journey/JourneyLanding.tsx index 9ce831ef7610..7eb489fe0e7f 100644 --- a/src/landings/components/journey/JourneyLanding.tsx +++ b/src/landings/components/journey/JourneyLanding.tsx @@ -1,14 +1,14 @@ import { DefaultLayout } from '@/frame/components/DefaultLayout' -import { useJourneyContext } from '@/landings/context/JourneyContext' +import { useLandingContext } from '@/landings/context/LandingContext' import { LandingHero } from '@/landings/components/shared/LandingHero' export const JourneyLanding = () => { - const { title, intro } = useJourneyContext() + const { title, intro, heroImage, introLinks } = useLandingContext() return (
- +
TODO
diff --git a/src/landings/components/shared/LandingHero.module.scss b/src/landings/components/shared/LandingHero.module.scss new file mode 100644 index 000000000000..9068b7d93e4c --- /dev/null +++ b/src/landings/components/shared/LandingHero.module.scss @@ -0,0 +1,191 @@ +.landingHero { + position: relative; + display: flex; + align-items: center; + padding: 4rem 0; + background-color: var(--bgColor-muted, var(--color-canvas-subtle, #f6f8fa)); + background-size: cover; + background-position: center center; + background-repeat: no-repeat; + overflow: hidden; + height: 28rem; + width: 100%; +} + +.heroContent { + position: relative; + width: 50rem; + max-width: 50rem; + padding: 0 7rem; + display: flex; + align-items: center; +} + +.heroText { + text-align: left; + width: 100%; +} + +.heroHeading { + font-size: 4rem; + font-weight: 600; + line-height: 1.2; + margin: 0 0 1rem 0; + color: var(--fgColor-default, var(--color-fg-default, #1f2328)); + max-width: 48rem; +} + +.heroDescription { + font-size: 1.25rem; + line-height: 1.5; + color: var(--fgColor-muted, var(--color-fg-muted, #656d76)); + margin: 0 0 2rem 0; + max-width: 36rem; +} + +.heroActions { + display: flex; + gap: 1rem; + flex-wrap: wrap; +} + +.heroAction { + display: inline-flex; + align-items: center; + justify-content: center; + padding: 0.75rem 1.5rem; + border-radius: 6px; + font-weight: 500; + text-decoration: none; + transition: all 0.2s ease; + min-height: 2.75rem; + border: 1px solid transparent; +} + +.heroPrimaryAction { + background-color: var( + --bgColor-success-emphasis, + var(--color-btn-primary-bg, #1f883d) + ); + color: var(--fgColor-onEmphasis, var(--color-btn-primary-text, #ffffff)); + border-color: var( + --borderColor-success-emphasis, + var(--color-btn-primary-border, #1f883d) + ); + + &:hover { + background-color: var( + --bgColor-success-emphasis, + var(--color-btn-primary-hover-bg, #1a7f37) + ); + border-color: var( + --borderColor-success-emphasis, + var(--color-btn-primary-hover-border, #1a7f37) + ); + text-decoration: none; + } + + &:focus { + outline: 2px solid + var( + --borderColor-success-emphasis, + var(--color-btn-primary-focus, #1f883d) + ); + outline-offset: 2px; + } +} + +.heroSecondaryAction { + background-color: transparent; + color: var(--fgColor-default, var(--color-fg-default, #1f2328)); + border-color: var( + --borderColor-default, + var(--color-border-default, #d1d9e0) + ); + + &:hover { + background-color: var(--bgColor-muted, var(--color-canvas-subtle, #f3f4f6)); + border-color: var( + --borderColor-default, + var(--color-border-default, #d1d9e0) + ); + text-decoration: none; + } + + &:focus { + outline: 2px solid + var(--borderColor-accent-emphasis, var(--color-accent-emphasis, #0969da)); + outline-offset: 2px; + } +} + +@media (max-width: 865px) { + .landingHero { + height: 24rem; + background-image: none !important; + flex-direction: column; + text-align: center; + justify-content: center; + background-color: var(--bgColor-muted, var(--color-canvas-subtle, #f6f8fa)); + } + + .heroContent { + width: 100%; + order: 2; + padding: 0 1rem; + } + + .heroHeading { + font-size: 3rem; + } + + .heroDescription { + font-size: 1.1rem; + } + + .heroActions { + justify-content: center; + } + + .heroAction { + width: auto; + min-width: 12rem; + } + + .heroText { + display: flex; + flex-direction: column; + align-items: center; + text-align: center; + } +} + +@media (max-width: 480px) { + .landingHero { + height: 32rem; + background-image: none !important; + background-color: var(--bgColor-muted, var(--color-canvas-subtle, #f6f8fa)); + flex-direction: column; + text-align: center; + padding: 2rem 0 1rem; + justify-content: center; + } + + .heroContent { + width: 100%; + order: 2; + padding: 1rem; + } + + .heroText { + display: flex; + flex-direction: column; + text-align: center; + align-items: center; + } + + .heroActions { + justify-content: center; + align-items: center; + } +} diff --git a/src/landings/components/shared/LandingHero.tsx b/src/landings/components/shared/LandingHero.tsx index fc717b2799a7..83649ecb4d76 100644 --- a/src/landings/components/shared/LandingHero.tsx +++ b/src/landings/components/shared/LandingHero.tsx @@ -1,18 +1,61 @@ -import { Lead } from '@/frame/components/ui/Lead/Lead' +import styles from './LandingHero.module.scss' +import { useTranslation } from '@/languages/components/useTranslation' type LandingHeroProps = { title: string intro?: string + heroImage?: string + introLinks?: Record | null } -export const LandingHero = ({ title, intro }: LandingHeroProps) => { +export const LandingHero = ({ title, intro, heroImage, introLinks }: LandingHeroProps) => { + const { t } = useTranslation(['product_landing']) + + const linkEntries = introLinks ? Object.entries(introLinks) : [] + const primaryAction = linkEntries[0] + const secondaryAction = linkEntries[1] + return ( -
-
-

TODO: Landing hero placeholder

-

{title}

- {intro && {intro}} +
+
+
+

{title}

+ {intro && ( +
+
+
+ )} + {(primaryAction || secondaryAction) && ( +
+ {primaryAction && ( + + {t(primaryAction[0])} + + )} + {secondaryAction && ( + + {t(secondaryAction[0])} + + )} +
+ )} +
-
+
) } diff --git a/src/landings/context/BespokeContext.tsx b/src/landings/context/BespokeContext.tsx deleted file mode 100644 index f7bd5b9ca940..000000000000 --- a/src/landings/context/BespokeContext.tsx +++ /dev/null @@ -1,49 +0,0 @@ -import { createContext, useContext } from 'react' -import { FeaturedLink, getFeaturedLinksFromReq } from '@/landings/components/ProductLandingContext' -import { mapRawTocItemToTocItem } from '@/landings/types' -import type { TocItem } from '@/landings/types' -import type { LearningTrack } from '@/types' - -export type BespokeContextT = { - title: string - intro: string - productCallout: string - permissions: string - tocItems: Array - variant?: 'compact' | 'expanded' - featuredLinks: Record> - renderedPage: string - currentLearningTrack?: LearningTrack - currentLayout: string -} - -export const BespokeContext = createContext(null) - -export const useBespokeContext = (): BespokeContextT => { - const context = useContext(BespokeContext) - - if (!context) { - throw new Error('"useBespokeContext" may only be used inside "BespokeContext.Provider"') - } - - return context -} - -export const getBespokeContextFromRequest = async (req: any): Promise => { - const page = req.context.page - - return { - title: page.title, - productCallout: page.product || '', - permissions: page.permissions || '', - intro: page.intro, - tocItems: (req.context.genericTocFlat || req.context.genericTocNested || []).map( - mapRawTocItemToTocItem, - ), - variant: req.context.genericTocFlat ? 'expanded' : 'compact', - featuredLinks: getFeaturedLinksFromReq(req), - renderedPage: req.context.renderedPage, - currentLearningTrack: req.context.currentLearningTrack, - currentLayout: req.context.currentLayoutName, - } -} diff --git a/src/landings/context/DiscoveryContext.tsx b/src/landings/context/DiscoveryContext.tsx deleted file mode 100644 index c4b13f2702d6..000000000000 --- a/src/landings/context/DiscoveryContext.tsx +++ /dev/null @@ -1,61 +0,0 @@ -import { createContext, useContext } from 'react' -import { FeaturedLink, getFeaturedLinksFromReq } from '@/landings/components/ProductLandingContext' -import { mapRawTocItemToTocItem } from '@/landings/types' -import type { TocItem } from '@/landings/types' -import type { LearningTrack } from '@/types' - -export type DiscoveryContextT = { - title: string - intro: string - productCallout: string - permissions: string - tocItems: Array - variant?: 'compact' | 'expanded' - featuredLinks: Record> - renderedPage: string - currentLearningTrack?: LearningTrack - currentLayout: string - recommended?: string[] // Array of article paths -} - -export const DiscoveryContext = createContext(null) - -export const useDiscoveryContext = (): DiscoveryContextT => { - const context = useContext(DiscoveryContext) - - if (!context) { - throw new Error('"useDiscoveryContext" may only be used inside "DiscoveryContext.Provider"') - } - - return context -} - -export const getDiscoveryContextFromRequest = async (req: any): Promise => { - const page = req.context.page - - // Support legacy `spotlight` property as `recommended` for pages like Copilot Cookbook - // However, `spotlight` will have lower priority than the `recommended` property - let recommended: string[] = [] - if (page.recommended && page.recommended.length > 0) { - recommended = page.recommended - } else if (page.spotlight && page.spotlight.length > 0) { - // Remove the `image` property from spotlight items, since we don't use those for the carousel - recommended = page.spotlight.map((item: any) => item.article) - } - - return { - title: page.title, - productCallout: page.product || '', - permissions: page.permissions || '', - intro: page.intro, - tocItems: (req.context.genericTocFlat || req.context.genericTocNested || []).map( - mapRawTocItemToTocItem, - ), - variant: req.context.genericTocFlat ? 'expanded' : 'compact', - featuredLinks: getFeaturedLinksFromReq(req), - renderedPage: req.context.renderedPage, - currentLearningTrack: req.context.currentLearningTrack, - currentLayout: req.context.currentLayoutName, - recommended, - } -} diff --git a/src/landings/context/JourneyContext.tsx b/src/landings/context/JourneyContext.tsx deleted file mode 100644 index 47c0c8340172..000000000000 --- a/src/landings/context/JourneyContext.tsx +++ /dev/null @@ -1,49 +0,0 @@ -import { createContext, useContext } from 'react' -import { FeaturedLink, getFeaturedLinksFromReq } from '@/landings/components/ProductLandingContext' -import { mapRawTocItemToTocItem } from '@/landings/types' -import type { TocItem } from '@/landings/types' -import type { LearningTrack } from '@/types' - -export type JourneyContextT = { - title: string - intro: string - productCallout: string - permissions: string - tocItems: Array - variant?: 'compact' | 'expanded' - featuredLinks: Record> - renderedPage: string - currentLearningTrack?: LearningTrack - currentLayout: string -} - -export const JourneyContext = createContext(null) - -export const useJourneyContext = (): JourneyContextT => { - const context = useContext(JourneyContext) - - if (!context) { - throw new Error('"useJourneyContext" may only be used inside "JourneyContext.Provider"') - } - - return context -} - -export const getJourneyContextFromRequest = async (req: any): Promise => { - const page = req.context.page - - return { - title: page.title, - productCallout: page.product || '', - permissions: page.permissions || '', - intro: page.intro, - tocItems: (req.context.genericTocFlat || req.context.genericTocNested || []).map( - mapRawTocItemToTocItem, - ), - variant: req.context.genericTocFlat ? 'expanded' : 'compact', - featuredLinks: getFeaturedLinksFromReq(req), - renderedPage: req.context.renderedPage, - currentLearningTrack: req.context.currentLearningTrack, - currentLayout: req.context.currentLayoutName, - } -} diff --git a/src/landings/context/LandingContext.tsx b/src/landings/context/LandingContext.tsx new file mode 100644 index 000000000000..0739c142295e --- /dev/null +++ b/src/landings/context/LandingContext.tsx @@ -0,0 +1,76 @@ +import { createContext, useContext } from 'react' +import { FeaturedLink, getFeaturedLinksFromReq } from '@/landings/components/ProductLandingContext' +import { mapRawTocItemToTocItem } from '@/landings/types' +import type { TocItem } from '@/landings/types' +import type { LearningTrack } from '@/types' + +export type LandingType = 'bespoke' | 'discovery' | 'journey' + +export type LandingContextT = { + landingType: LandingType + title: string + intro: string + productCallout: string + permissions: string + tocItems: Array + variant?: 'compact' | 'expanded' + featuredLinks: Record> + renderedPage: string + currentLearningTrack?: LearningTrack + currentLayout: string + heroImage?: string + // For discovery landing pages + recommended?: string[] // Array of article paths + // For discovery landing pages + introLinks?: Record +} + +export const LandingContext = createContext(null) + +export const useLandingContext = (): LandingContextT => { + const context = useContext(LandingContext) + + if (!context) { + throw new Error('"useLandingContext" may only be used inside "LandingContext.Provider"') + } + + return context +} + +export const getLandingContextFromRequest = async ( + req: any, + landingType: LandingType, +): Promise => { + const page = req.context.page + + let recommended: string[] = [] + if (landingType === 'discovery') { + // Support legacy `spotlight` property as `recommended` for pages like Copilot Cookbook + // However, `spotlight` will have lower priority than the `recommended` property + if (page.recommended && page.recommended.length > 0) { + recommended = page.recommended + } else if (page.spotlight && page.spotlight.length > 0) { + // Remove the `image` property from spotlight items, since we don't use those for the carousel + recommended = page.spotlight.map((item: any) => item.article) + } + } + + return { + landingType, + title: page.title, + productCallout: page.product || '', + permissions: page.permissions || '', + intro: page.intro, + tocItems: (req.context.genericTocFlat || req.context.genericTocNested || []).map( + mapRawTocItemToTocItem, + ), + variant: req.context.genericTocFlat ? 'expanded' : 'compact', + featuredLinks: getFeaturedLinksFromReq(req), + renderedPage: req.context.renderedPage, + currentLearningTrack: req.context.currentLearningTrack, + currentLayout: req.context.currentLayoutName, + heroImage: page.heroImage || '/assets/images/banner-images/hero-1.png', + introLinks: page.introLinks || null, + recommended, + } +} diff --git a/src/landings/pages/product.tsx b/src/landings/pages/product.tsx index eeed5a9c96d6..c5414d908267 100644 --- a/src/landings/pages/product.tsx +++ b/src/landings/pages/product.tsx @@ -49,22 +49,12 @@ import { } from '@/frame/components/context/CategoryLandingContext' import { BespokeLanding } from '@/landings/components/bespoke/BespokeLanding' import { - BespokeContext, - getBespokeContextFromRequest, - BespokeContextT, -} from '@/landings/context/BespokeContext' + LandingContext, + getLandingContextFromRequest, + LandingContextT, +} from '@/landings/context/LandingContext' import { DiscoveryLanding } from '@/landings/components/discovery/DiscoveryLanding' -import { - DiscoveryContext, - DiscoveryContextT, - getDiscoveryContextFromRequest, -} from '@/landings/context/DiscoveryContext' import { JourneyLanding } from '@/landings/components/journey/JourneyLanding' -import { - getJourneyContextFromRequest, - JourneyContext, - JourneyContextT, -} from '@/landings/context/JourneyContext' function initiateArticleScripts() { copyCode() @@ -79,9 +69,9 @@ type Props = { tocLandingContext?: TocLandingContextT articleContext?: ArticleContextT categoryLandingContext?: CategoryLandingContextT - bespokeContext?: BespokeContextT - discoveryContext?: DiscoveryContextT - journeyContext?: JourneyContextT + bespokeContext?: LandingContextT + discoveryContext?: LandingContextT + journeyContext?: LandingContextT } const GlobalPage = ({ mainContext, @@ -108,21 +98,21 @@ const GlobalPage = ({ let content if (bespokeContext) { content = ( - + - + ) } else if (discoveryContext) { content = ( - + - + ) } else if (journeyContext) { content = ( - + - + ) } else if (productLandingContext) { content = ( @@ -184,23 +174,23 @@ export const getServerSideProps: GetServerSideProps = async (context) => // This looks a little funky, but it's so we only send one context's data to the client // TODO: TEMP: This is a temporary solution to turn off/on new landing pages while we develop them if (currentLayoutName === 'bespoke-landing' || req.query?.feature === 'bespoke-landing') { - props.bespokeContext = await getBespokeContextFromRequest(req) - additionalUINamespaces.push('bespoke_landing') + props.bespokeContext = await getLandingContextFromRequest(req, 'bespoke') + additionalUINamespaces.push('bespoke_landing', 'product_landing') } else if (currentLayoutName === 'journey-landing' || req.query?.feature === 'journey-landing') { - props.journeyContext = await getJourneyContextFromRequest(req) - additionalUINamespaces.push('journey_landing') + props.journeyContext = await getLandingContextFromRequest(req, 'journey') + additionalUINamespaces.push('journey_landing', 'product_landing') } else if ( currentLayoutName === 'discovery-landing' || req?.query?.feature === 'discovery-landing' ) { - props.discoveryContext = await getDiscoveryContextFromRequest(req) - additionalUINamespaces.push('discovery_landing') + props.discoveryContext = await getLandingContextFromRequest(req, 'discovery') + additionalUINamespaces.push('discovery_landing', 'product_landing') } else if (currentLayoutName === 'product-landing') { props.productLandingContext = await getProductLandingContextFromRequest(req) additionalUINamespaces.push('product_landing') } else if (currentLayoutName === 'product-guides') { props.productGuidesContext = getProductGuidesContextFromRequest(req) - additionalUINamespaces.push('product_guides') + additionalUINamespaces.push('product_guides', 'product_landing') } else if (relativePath?.endsWith('index.md')) { if (currentLayoutName === 'category-landing') { props.categoryLandingContext = getCategoryLandingContextFromRequest(req) diff --git a/src/links/scripts/rendered-content-link-checker.ts b/src/links/scripts/rendered-content-link-checker.ts index f2a847070d4e..dacfe7009718 100755 --- a/src/links/scripts/rendered-content-link-checker.ts +++ b/src/links/scripts/rendered-content-link-checker.ts @@ -1073,6 +1073,20 @@ async function checkExternalURLCached( const now = new Date().getTime() const url = href.split('#')[0] + // Skip domains that are currently rate limited (with 1 hour TTL) + const { hostname } = new URL(url) + const rateLimitTime = _rateLimitedDomains.get(hostname) + if (rateLimitTime) { + const oneHourAgo = Date.now() - 60 * 60 * 1000 // 1 hour in ms + if (rateLimitTime > oneHourAgo) { + if (verbose) core.info(`Skipping ${url} - domain ${hostname} is rate limited`) + return { ok: false, statusCode: 429, skipReason: 'Domain rate limited' } + } else { + // Rate limit has expired, remove it + _rateLimitedDomains.delete(hostname) + } + } + if (cacheMaxAge) { const tooOld = now - Math.floor(jitter(cacheMaxAge, 10)) if (db && db.data.urls[url]) { @@ -1122,105 +1136,70 @@ async function checkExternalURL( return _fetchCache.get(cleanURL) } -const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms)) - -// Global for recording which domains we get rate-limited on. -// For example, if you got rate limited on `something.github.com/foo` -// and now we're asked to fetch for `something.github.com/bar` -// it's good to know to now bother yet. -const _rateLimitedDomains = new Map() +// Track domains that have returned 429 to skip future requests +// Maps hostname to timestamp when rate limit was detected +const _rateLimitedDomains = new Map() async function innerFetch( core: CoreInject, url: string, - config: { verbose?: boolean; useGET?: boolean; patient?: boolean; retries?: number } = {}, + config: { verbose?: boolean; patient?: boolean; retries?: number } = {}, ) { - const { verbose, useGET, patient } = config - - const { hostname } = new URL(url) - if (_rateLimitedDomains.has(hostname)) { - await sleep(_rateLimitedDomains.get(hostname)) - } - // The way `got` does retries: - // - // sleep = 1000 * Math.pow(2, retry - 1) + Math.random() * 100 - // - // So, it means: - // - // 1. ~1000ms - // 2. ~2000ms - // 3. ~4000ms - // - // ...if the limit we set is 3. - // Our own timeout, in @/frame/middleware/timeout.js defaults to 10 seconds. - // So there's no point in trying more attempts than 3 because it would - // just timeout on the 10s. (i.e. 1000 + 2000 + 4000 + 8000 > 10,000) - const retry = { - limit: patient ? 6 : 2, - } - const timeout = { request: patient ? 10000 : 2000 } + const { verbose, patient } = config const headers = { 'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.117 Safari/537.36', } - const retries = config.retries || 0 - const method = useGET ? 'GET' : 'HEAD' + const retries = patient ? 3 : 2 + const timeout = patient ? 10000 : 5000 + + if (verbose) core.info(`External URL HEAD: ${url}`) - if (verbose) core.info(`External URL ${method}: ${url} (retries: ${retries})`) try { - const r = await fetchWithRetry( + // Try HEAD first + let r = await fetchWithRetry( url, { - method, + method: 'HEAD', headers, }, { - retries: retry.limit, - timeout: timeout.request, + retries, + timeout, throwHttpErrors: false, }, ) + + // If HEAD doesn't work, try GET + if (r.status === 405 || r.status === 404 || r.status === 403) { + if (verbose) core.info(`External URL GET: ${url} (HEAD failed with ${r.status})`) + r = await fetchWithRetry( + url, + { + method: 'GET', + headers, + }, + { + retries, + timeout, + throwHttpErrors: false, + }, + ) + } + if (verbose) { - core.info(`External URL ${method} ${url}: ${r.status} (retries: ${retries})`) + core.info(`External URL ${url}: ${r.status}`) } - // If we get rate limited, remember that this hostname is now all - // rate limited. And sleep for the number of seconds that the - // `retry-after` header indicated. + // Track rate limited domains with timestamp + const { hostname } = new URL(url) if (r.status === 429) { - let sleepTime = Math.min( - 60_000, - Math.max( - 10_000, - r.headers.get('retry-after') ? getRetryAfterSleep(r.headers.get('retry-after')) : 1_000, - ), - ) - // Sprinkle a little jitter so it doesn't all start again all - // at the same time - sleepTime += Math.random() * 10 * 1000 - // Give it a bit extra when we can be really patient - if (patient) sleepTime += 30 * 1000 - - _rateLimitedDomains.set(hostname, sleepTime + Math.random() * 10 * 1000) - if (verbose) - core.info( - chalk.yellow( - `Rate limited on ${hostname} (${url}). Sleeping for ${(sleepTime / 1000).toFixed(1)}s`, - ), - ) - await sleep(sleepTime) - return innerFetch(core, url, Object.assign({}, config, { retries: retries + 1 })) - } else { - _rateLimitedDomains.delete(hostname) + _rateLimitedDomains.set(hostname, Date.now()) + if (verbose) core.info(`Domain ${hostname} is now rate limited for 1 hour`) } - // Perhaps the server doesn't support HEAD requests. - // If so, try again with a regular GET. - if ((r.status === 405 || r.status === 404 || r.status === 403) && !useGET) { - return innerFetch(core, url, Object.assign({}, config, { useGET: true })) - } if (verbose) { core.info((r.ok ? chalk.green : chalk.red)(`${r.status} on ${url}`)) } @@ -1236,17 +1215,6 @@ async function innerFetch( } } -// Return number of milliseconds from a `Retry-After` header value -function getRetryAfterSleep(headerValue: string | null) { - if (!headerValue) return 0 - let ms = Math.round(parseFloat(headerValue) * 1000) - if (isNaN(ms)) { - const nextDate = new Date(headerValue) - ms = Math.max(0, nextDate.getTime() - new Date().getTime()) - } - return ms -} - function checkImageSrc(src: string) { if (!src.startsWith('/') && !src.startsWith('http')) { return { CRITICAL: 'Image path is not absolute. Should start with a /' } diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index d3bfe3457022..1f703597b8a6 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -432679,11 +432679,11 @@ }, "before_sha": { "type": "string", - "description": "The first commit sha before the push evaluation." + "description": "The previous commit SHA of the ref." }, "after_sha": { "type": "string", - "description": "The last commit sha in the push evaluation." + "description": "The new commit SHA of the ref." }, "ref": { "type": "string", @@ -461020,6 +461020,10481 @@ } ] }, + "projects": { + "projects": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2", + "title": "List projects for organization", + "category": "projects", + "subcategory": "projects", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "q", + "description": "

Limit results to projects of the specified type.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 2, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "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 + }, + "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 + }, + "title": "My Projects", + "description": "A board to manage my personal projects.", + "public": true, + "closed_at": null, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "number": 2, + "short_description": null, + "deleted_at": null, + "deleted_by": null, + "state": "open", + "latest_status_update": { + "id": 3, + "node_id": "PVTSU_lAECAQM", + "creator": { + "login": "hubot", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": false + }, + "body": "DONE", + "start_date": "2025-07-23", + "target_date": "2025-07-26", + "status": "COMPLETE", + "created_at": "2025-07-11T16:19:28Z", + "updated_at": "2025-07-11T16:19:28Z" + }, + "is_template": true + }, + "schema": { + "type": "array", + "items": { + "title": "Projects v2 Project", + "description": "A projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "title": { + "type": "string", + "description": "The project title." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A short description of the project." + }, + "public": { + "type": "boolean", + "description": "Whether the project is visible to anyone with access to the owner." + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was closed.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "number": { + "type": "integer", + "description": "The project number." + }, + "short_description": { + "type": [ + "string", + "null" + ], + "description": "A concise summary of the project." + }, + "deleted_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was deleted.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "deleted_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + } + ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ], + "description": "The current state of the project." + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the status update." + }, + "node_id": { + "type": "string", + "description": "The node ID of the status update." + }, + "project_node_id": { + "type": "string", + "description": "The node ID of the project that this status update belongs to." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ], + "description": "The current status." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the period covered by the update.", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "description": "The target date associated with the update.", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" + } + }, + "required": [ + "id", + "node_id", + "owner", + "creator", + "title", + "description", + "public", + "closed_at", + "created_at", + "updated_at", + "number", + "short_description", + "deleted_at", + "deleted_by" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

List all projects owned by a specific organization accessible by the authenticated user.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}", + "title": "Get project for organization", + "category": "projects", + "subcategory": "projects", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 2, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "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 + }, + "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 + }, + "title": "My Projects", + "description": "A board to manage my personal projects.", + "public": true, + "closed_at": null, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "number": 2, + "short_description": null, + "deleted_at": null, + "deleted_by": null, + "state": "open", + "latest_status_update": { + "id": 3, + "node_id": "PVTSU_lAECAQM", + "creator": { + "login": "hubot", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": false + }, + "body": "DONE", + "start_date": "2025-07-23", + "target_date": "2025-07-26", + "status": "COMPLETE", + "created_at": "2025-07-11T16:19:28Z", + "updated_at": "2025-07-11T16:19:28Z" + }, + "is_template": true + }, + "schema": { + "title": "Projects v2 Project", + "description": "A projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "title": { + "type": "string", + "description": "The project title." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A short description of the project." + }, + "public": { + "type": "boolean", + "description": "Whether the project is visible to anyone with access to the owner." + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was closed.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "number": { + "type": "integer", + "description": "The project number." + }, + "short_description": { + "type": [ + "string", + "null" + ], + "description": "A concise summary of the project." + }, + "deleted_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was deleted.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "deleted_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + } + ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ], + "description": "The current state of the project." + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the status update." + }, + "node_id": { + "type": "string", + "description": "The node ID of the status update." + }, + "project_node_id": { + "type": "string", + "description": "The node ID of the project that this status update belongs to." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ], + "description": "The current status." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the period covered by the update.", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "description": "The target date associated with the update.", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" + } + }, + "required": [ + "id", + "node_id", + "owner", + "creator", + "title", + "description", + "public", + "closed_at", + "created_at", + "updated_at", + "number", + "short_description", + "deleted_at", + "deleted_by" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Get a specific organization-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{user_id}/projectsV2/{project_number}", + "title": "Get project for user", + "category": "projects", + "subcategory": "projects", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "user_id": "USER_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 2, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "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 + }, + "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 + }, + "title": "My Projects", + "description": "A board to manage my personal projects.", + "public": true, + "closed_at": null, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "number": 2, + "short_description": null, + "deleted_at": null, + "deleted_by": null, + "state": "open", + "latest_status_update": { + "id": 3, + "node_id": "PVTSU_lAECAQM", + "creator": { + "login": "hubot", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": false + }, + "body": "DONE", + "start_date": "2025-07-23", + "target_date": "2025-07-26", + "status": "COMPLETE", + "created_at": "2025-07-11T16:19:28Z", + "updated_at": "2025-07-11T16:19:28Z" + }, + "is_template": true + }, + "schema": { + "title": "Projects v2 Project", + "description": "A projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "title": { + "type": "string", + "description": "The project title." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A short description of the project." + }, + "public": { + "type": "boolean", + "description": "Whether the project is visible to anyone with access to the owner." + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was closed.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "number": { + "type": "integer", + "description": "The project number." + }, + "short_description": { + "type": [ + "string", + "null" + ], + "description": "A concise summary of the project." + }, + "deleted_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was deleted.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "deleted_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + } + ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ], + "description": "The current state of the project." + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the status update." + }, + "node_id": { + "type": "string", + "description": "The node ID of the status update." + }, + "project_node_id": { + "type": "string", + "description": "The node ID of the project that this status update belongs to." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ], + "description": "The current status." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the period covered by the update.", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "description": "The target date associated with the update.", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" + } + }, + "required": [ + "id", + "node_id", + "owner", + "creator", + "title", + "description", + "public", + "closed_at", + "created_at", + "updated_at", + "number", + "short_description", + "deleted_at", + "deleted_by" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Get a specific user-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/projectsV2", + "title": "List projects for user", + "category": "projects", + "subcategory": "projects", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "q", + "description": "

Limit results to projects of the specified type.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 2, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "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 + }, + "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 + }, + "title": "My Projects", + "description": "A board to manage my personal projects.", + "public": true, + "closed_at": null, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "number": 2, + "short_description": null, + "deleted_at": null, + "deleted_by": null, + "state": "open", + "latest_status_update": { + "id": 3, + "node_id": "PVTSU_lAECAQM", + "creator": { + "login": "hubot", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": false + }, + "body": "DONE", + "start_date": "2025-07-23", + "target_date": "2025-07-26", + "status": "COMPLETE", + "created_at": "2025-07-11T16:19:28Z", + "updated_at": "2025-07-11T16:19:28Z" + }, + "is_template": true + }, + "schema": { + "type": "array", + "items": { + "title": "Projects v2 Project", + "description": "A projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "title": { + "type": "string", + "description": "The project title." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A short description of the project." + }, + "public": { + "type": "boolean", + "description": "Whether the project is visible to anyone with access to the owner." + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was closed.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "number": { + "type": "integer", + "description": "The project number." + }, + "short_description": { + "type": [ + "string", + "null" + ], + "description": "A concise summary of the project." + }, + "deleted_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was deleted.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "deleted_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + } + ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ], + "description": "The current state of the project." + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the status update." + }, + "node_id": { + "type": "string", + "description": "The node ID of the status update." + }, + "project_node_id": { + "type": "string", + "description": "The node ID of the project that this status update belongs to." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ], + "description": "The current status." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the period covered by the update.", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "description": "The target date associated with the update.", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" + } + }, + "required": [ + "id", + "node_id", + "owner", + "creator", + "title", + "description", + "public", + "closed_at", + "created_at", + "updated_at", + "number", + "short_description", + "deleted_at", + "deleted_by" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

List all projects owned by a specific user accessible by the authenticated user.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + } + ], + "fields": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields", + "title": "List project fields for organization", + "category": "projects", + "subcategory": "fields", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": "Low", + "color": "GREEN", + "description": "Low priority items" + }, + { + "id": "option_2", + "name": "Medium", + "color": "YELLOW", + "description": "Medium priority items" + }, + { + "id": "option_3", + "name": "High", + "color": "RED", + "description": "High priority items" + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + "schema": { + "type": "array", + "items": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

List all fields for a specific organization-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}", + "title": "Get project field for organization", + "category": "projects", + "subcategory": "fields", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "

The unique identifier of the field.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "field_id": "FIELD_ID", + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": "Low", + "color": "GREEN", + "description": "Low priority items" + }, + { + "id": "option_2", + "name": "Medium", + "color": "YELLOW", + "description": "Medium priority items" + }, + { + "id": "option_3", + "name": "High", + "color": "RED", + "description": "High priority items" + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Get a specific field for an organization-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{user_id}/projectsV2/{project_number}/fields", + "title": "List project fields for user", + "category": "projects", + "subcategory": "fields", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "user_id": "USER_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": "Low", + "color": "GREEN", + "description": "Low priority items" + }, + { + "id": "option_2", + "name": "Medium", + "color": "YELLOW", + "description": "Medium priority items" + }, + { + "id": "option_3", + "name": "High", + "color": "RED", + "description": "High priority items" + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + "schema": { + "type": "array", + "items": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

List all fields for a specific user-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{user_id}/projectsV2/{project_number}/fields/{field_id}", + "title": "Get project field for user", + "category": "projects", + "subcategory": "fields", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "

The unique identifier of the field.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "field_id": "FIELD_ID", + "user_id": "USER_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": "Low", + "color": "GREEN", + "description": "Low priority items" + }, + { + "id": "option_2", + "name": "Medium", + "color": "YELLOW", + "description": "Medium priority items" + }, + { + "id": "option_3", + "name": "High", + "color": "RED", + "description": "High priority items" + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Get a specific field for a user-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + } + ], + "items": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items", + "title": "List items for an organization owned project", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "q", + "description": "

Search query to filter items, see Filtering projects for more information.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "fields", + "description": "

Limit results to specific fields, by their IDs. If not specified, the title field will be returned.

", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "examples": [ + "fields[]=123,fields[]=456,fields[]=789" + ] + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 13, + "node_id": "PVTI_lAAFAQ0", + "project_url": "https://api.github.com/orgs/github/projectsV2/1", + "content": { + "url": "https://api.github.com/repos/github/Hello-World/pulls/6", + "id": 10, + "node_id": "PR_kwABCg", + "html_url": "https://github.com/github/Hello-World/pull/6", + "diff_url": "https://github.com/github/Hello-World/pull/6.diff", + "patch_url": "https://github.com/github/Hello-World/pull/6.patch", + "issue_url": "https://api.github.com/repos/github/Hello-World/issues/6", + "number": 6, + "state": "open", + "locked": false, + "title": "Issue title", + "user": { + "login": "monalisa", + "id": 161, + "node_id": "U_kgDMoQ", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "body": "Issue body", + "created_at": "2025-08-01T18:44:50Z", + "updated_at": "2025-08-06T19:25:18Z", + "closed_at": null, + "merged_at": null, + "merge_commit_sha": "98e25bad5878e54d22e5338cbc905dd2deedfa34", + "assignee": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_reviewers": [ + { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_teams": [], + "labels": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ], + "milestone": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + }, + "draft": false, + "commits_url": "https://api.github.com/repos/github/Hello-World/pulls/6/commits", + "review_comments_url": "https://api.github.com/repos/github/Hello-World/pulls/6/comments", + "review_comment_url": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/github/Hello-World/issues/6/comments", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "head": { + "label": "github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "ref": "branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "sha": "a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "base": { + "label": "github:branch-0f4ceb14cbe39e4786ffbabb776da599", + "ref": "branch-0f4ceb14cbe39e4786ffbabb776da599", + "sha": "9a9f5a8d77bdc2540412900d3c930fe36a82b5ed", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6" + }, + "html": { + "href": "https://github.com/github/Hello-World/pull/6" + }, + "issue": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6" + }, + "comments": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d" + } + }, + "author_association": "MEMBER", + "auto_merge": null, + "active_lock_reason": null + }, + "content_type": "PullRequest", + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "created_at": "2025-08-01T18:44:51Z", + "updated_at": "2025-08-06T19:25:18Z", + "archived_at": null, + "item_url": "https://api.github.com/orgs/github/projectsV2/1/items/13", + "fields": [ + { + "id": 1, + "name": "Title", + "type": "title", + "value": { + "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "number": 6, + "url": "https://github.com/5/1/pull/6", + "issue_id": 12, + "state": "open", + "state_reason": null, + "is_draft": false + } + }, + { + "id": 2, + "name": "Assignees", + "type": "assignees", + "value": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ] + }, + { + "id": 3, + "name": "Status", + "type": "single_select", + "value": { + "id": "98236657", + "name": "Done", + "name_html": "Done", + "color": "PURPLE", + "description": "This has been completed", + "description_html": "This has been completed" + } + }, + { + "id": 4, + "name": "Labels", + "type": "labels", + "value": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ] + }, + { + "id": 5, + "name": "Linked pull requests", + "type": "linked_pull_requests", + "value": [] + }, + { + "id": 6, + "name": "Milestone", + "type": "milestone", + "value": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + } + }, + { + "id": 7, + "name": "Repository", + "type": "repository", + "value": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments" + } + }, + { + "id": 8, + "name": "Type", + "type": "issue_type", + "value": null + }, + { + "id": 9, + "name": "Reviewers", + "type": "reviewers", + "value": [ + { + "type": "ReviewRequest", + "status": "pending", + "reviewer": { + "avatarUrl": "https://github.com/images/error/octocat_happy.gif", + "id": 2, + "login": "monalisa", + "url": "https://github.com/monalisa", + "name": "monalisa", + "type": "User" + } + } + ] + }, + { + "id": 10, + "name": "Parent issue", + "type": "parent_issue", + "value": null + }, + { + "id": 11, + "name": "Sub-issues progress", + "type": "sub_issues_progress", + "value": null + } + ] + }, + "schema": { + "type": "array", + "items": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "project_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the project that contains this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/3" + ] + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "content": { + "type": [ + "object", + "null" + ], + "additionalProperties": true, + "description": "The content of the item, which varies by content type." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the item was archived.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "item_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The API URL of this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/items/3" + ] + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + }, + "description": "The fields and values associated with this item." + } + }, + "required": [ + "id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

List all items for a specific organization-owned project accessible by the authenticated user.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items", + "title": "Add item to organization owned project", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "type", + "in": "body", + "description": "

The type of item to add to the project. Must be either Issue or PullRequest.

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest" + ] + }, + { + "type": "integer", + "name": "id", + "in": "body", + "description": "

The numeric ID of the issue or pull request to add to the project.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [], + "previews": [], + "descriptionHTML": "

Add an issue or pull request item to the specified organization owned project.

", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "title": "Get an item for an organization owned project", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "item_id", + "description": "

The unique identifier of the project item.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "fields", + "description": "

Limit results to specific fields, by their IDs. If not specified, the title field will be returned.

", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "examples": [ + "fields[]=123,fields[]=456,fields[]=789" + ] + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG", + "item_id": "ITEM_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 13, + "node_id": "PVTI_lAAFAQ0", + "project_url": "https://api.github.com/orgs/github/projectsV2/1", + "content": { + "url": "https://api.github.com/repos/github/Hello-World/pulls/6", + "id": 10, + "node_id": "PR_kwABCg", + "html_url": "https://github.com/github/Hello-World/pull/6", + "diff_url": "https://github.com/github/Hello-World/pull/6.diff", + "patch_url": "https://github.com/github/Hello-World/pull/6.patch", + "issue_url": "https://api.github.com/repos/github/Hello-World/issues/6", + "number": 6, + "state": "open", + "locked": false, + "title": "Issue title", + "user": { + "login": "monalisa", + "id": 161, + "node_id": "U_kgDMoQ", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "body": "Issue body", + "created_at": "2025-08-01T18:44:50Z", + "updated_at": "2025-08-06T19:25:18Z", + "closed_at": null, + "merged_at": null, + "merge_commit_sha": "98e25bad5878e54d22e5338cbc905dd2deedfa34", + "assignee": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_reviewers": [ + { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_teams": [], + "labels": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ], + "milestone": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + }, + "draft": false, + "commits_url": "https://api.github.com/repos/github/Hello-World/pulls/6/commits", + "review_comments_url": "https://api.github.com/repos/github/Hello-World/pulls/6/comments", + "review_comment_url": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/github/Hello-World/issues/6/comments", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "head": { + "label": "github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "ref": "branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "sha": "a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "base": { + "label": "github:branch-0f4ceb14cbe39e4786ffbabb776da599", + "ref": "branch-0f4ceb14cbe39e4786ffbabb776da599", + "sha": "9a9f5a8d77bdc2540412900d3c930fe36a82b5ed", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6" + }, + "html": { + "href": "https://github.com/github/Hello-World/pull/6" + }, + "issue": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6" + }, + "comments": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d" + } + }, + "author_association": "MEMBER", + "auto_merge": null, + "active_lock_reason": null + }, + "content_type": "PullRequest", + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "created_at": "2025-08-01T18:44:51Z", + "updated_at": "2025-08-06T19:25:18Z", + "archived_at": null, + "item_url": "https://api.github.com/orgs/github/projectsV2/1/items/13", + "fields": [ + { + "id": 1, + "name": "Title", + "type": "title", + "value": { + "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "number": 6, + "url": "https://github.com/5/1/pull/6", + "issue_id": 12, + "state": "open", + "state_reason": null, + "is_draft": false + } + }, + { + "id": 2, + "name": "Assignees", + "type": "assignees", + "value": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ] + }, + { + "id": 3, + "name": "Status", + "type": "single_select", + "value": { + "id": "98236657", + "name": "Done", + "name_html": "Done", + "color": "PURPLE", + "description": "This has been completed", + "description_html": "This has been completed" + } + }, + { + "id": 4, + "name": "Labels", + "type": "labels", + "value": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ] + }, + { + "id": 5, + "name": "Linked pull requests", + "type": "linked_pull_requests", + "value": [] + }, + { + "id": 6, + "name": "Milestone", + "type": "milestone", + "value": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + } + }, + { + "id": 7, + "name": "Repository", + "type": "repository", + "value": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments" + } + }, + { + "id": 8, + "name": "Type", + "type": "issue_type", + "value": null + }, + { + "id": 9, + "name": "Reviewers", + "type": "reviewers", + "value": [ + { + "type": "ReviewRequest", + "status": "pending", + "reviewer": { + "avatarUrl": "https://github.com/images/error/octocat_happy.gif", + "id": 2, + "login": "monalisa", + "url": "https://github.com/monalisa", + "name": "monalisa", + "type": "User" + } + } + ] + }, + { + "id": 10, + "name": "Parent issue", + "type": "parent_issue", + "value": null + }, + { + "id": 11, + "name": "Sub-issues progress", + "type": "sub_issues_progress", + "value": null + } + ] + }, + "schema": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "project_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the project that contains this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/3" + ] + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "content": { + "type": [ + "object", + "null" + ], + "additionalProperties": true, + "description": "The content of the item, which varies by content type." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the item was archived.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "item_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The API URL of this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/items/3" + ] + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + }, + "description": "The fields and values associated with this item." + } + }, + "required": [ + "id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Get a specific item from an organization-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "title": "Update project item for organization", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "item_id", + "description": "

The unique identifier of the project item.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "array of objects", + "name": "fields", + "in": "body", + "description": "

A list of field updates to apply.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the project field to update.

", + "isRequired": true + }, + { + "type": "null or string or number", + "name": "value", + "description": "

The new value for the field:

\n
    \n
  • For text, number, and date fields, provide the new value directly.
    • \n
  • For single select and iteration fields, provide the ID of the option or iteration.
    • \n
  • To clear the field, set this to null.
    • \n
", + "isRequired": true + } + ] + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [], + "previews": [], + "descriptionHTML": "

Update a specific item in an organization-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "title": "Delete project item for organization", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "item_id", + "description": "

The unique identifier of the project item.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG", + "item_id": "ITEM_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Delete a specific item from an organization-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{user_id}/projectsV2/{project_number}/items", + "title": "List items for a user owned project", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "q", + "description": "

Search query to filter items, see Filtering projects for more information.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "fields", + "description": "

Limit results to specific fields, by their IDs. If not specified, the title field will be returned.

", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "examples": [ + "fields[]=123,fields[]=456,fields[]=789" + ] + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "user_id": "USER_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 13, + "node_id": "PVTI_lAAFAQ0", + "project_url": "https://api.github.com/orgs/github/projectsV2/1", + "content": { + "url": "https://api.github.com/repos/github/Hello-World/pulls/6", + "id": 10, + "node_id": "PR_kwABCg", + "html_url": "https://github.com/github/Hello-World/pull/6", + "diff_url": "https://github.com/github/Hello-World/pull/6.diff", + "patch_url": "https://github.com/github/Hello-World/pull/6.patch", + "issue_url": "https://api.github.com/repos/github/Hello-World/issues/6", + "number": 6, + "state": "open", + "locked": false, + "title": "Issue title", + "user": { + "login": "monalisa", + "id": 161, + "node_id": "U_kgDMoQ", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "body": "Issue body", + "created_at": "2025-08-01T18:44:50Z", + "updated_at": "2025-08-06T19:25:18Z", + "closed_at": null, + "merged_at": null, + "merge_commit_sha": "98e25bad5878e54d22e5338cbc905dd2deedfa34", + "assignee": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_reviewers": [ + { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_teams": [], + "labels": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ], + "milestone": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + }, + "draft": false, + "commits_url": "https://api.github.com/repos/github/Hello-World/pulls/6/commits", + "review_comments_url": "https://api.github.com/repos/github/Hello-World/pulls/6/comments", + "review_comment_url": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/github/Hello-World/issues/6/comments", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "head": { + "label": "github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "ref": "branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "sha": "a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "base": { + "label": "github:branch-0f4ceb14cbe39e4786ffbabb776da599", + "ref": "branch-0f4ceb14cbe39e4786ffbabb776da599", + "sha": "9a9f5a8d77bdc2540412900d3c930fe36a82b5ed", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6" + }, + "html": { + "href": "https://github.com/github/Hello-World/pull/6" + }, + "issue": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6" + }, + "comments": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d" + } + }, + "author_association": "MEMBER", + "auto_merge": null, + "active_lock_reason": null + }, + "content_type": "PullRequest", + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "created_at": "2025-08-01T18:44:51Z", + "updated_at": "2025-08-06T19:25:18Z", + "archived_at": null, + "item_url": "https://api.github.com/orgs/github/projectsV2/1/items/13", + "fields": [ + { + "id": 1, + "name": "Title", + "type": "title", + "value": { + "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "number": 6, + "url": "https://github.com/5/1/pull/6", + "issue_id": 12, + "state": "open", + "state_reason": null, + "is_draft": false + } + }, + { + "id": 2, + "name": "Assignees", + "type": "assignees", + "value": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ] + }, + { + "id": 3, + "name": "Status", + "type": "single_select", + "value": { + "id": "98236657", + "name": "Done", + "name_html": "Done", + "color": "PURPLE", + "description": "This has been completed", + "description_html": "This has been completed" + } + }, + { + "id": 4, + "name": "Labels", + "type": "labels", + "value": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ] + }, + { + "id": 5, + "name": "Linked pull requests", + "type": "linked_pull_requests", + "value": [] + }, + { + "id": 6, + "name": "Milestone", + "type": "milestone", + "value": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + } + }, + { + "id": 7, + "name": "Repository", + "type": "repository", + "value": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments" + } + }, + { + "id": 8, + "name": "Type", + "type": "issue_type", + "value": null + }, + { + "id": 9, + "name": "Reviewers", + "type": "reviewers", + "value": [ + { + "type": "ReviewRequest", + "status": "pending", + "reviewer": { + "avatarUrl": "https://github.com/images/error/octocat_happy.gif", + "id": 2, + "login": "monalisa", + "url": "https://github.com/monalisa", + "name": "monalisa", + "type": "User" + } + } + ] + }, + { + "id": 10, + "name": "Parent issue", + "type": "parent_issue", + "value": null + }, + { + "id": 11, + "name": "Sub-issues progress", + "type": "sub_issues_progress", + "value": null + } + ] + }, + "schema": { + "type": "array", + "items": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "project_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the project that contains this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/3" + ] + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "content": { + "type": [ + "object", + "null" + ], + "additionalProperties": true, + "description": "The content of the item, which varies by content type." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the item was archived.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "item_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The API URL of this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/items/3" + ] + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + }, + "description": "The fields and values associated with this item." + } + }, + "required": [ + "id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

List all items for a specific user-owned project accessible by the authenticated user.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{user_id}/projectsV2/{project_number}/items", + "title": "Add item to user owned project", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "type", + "in": "body", + "description": "

The type of item to add to the project. Must be either Issue or PullRequest.

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest" + ] + }, + { + "type": "integer", + "name": "id", + "in": "body", + "description": "

The numeric ID of the issue or pull request to add to the project.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [], + "previews": [], + "descriptionHTML": "

Add an issue or pull request item to the specified user owned project.

", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{user_id}/projectsV2/{project_number}/items/{item_id}", + "title": "Get an item for a user owned project", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "item_id", + "description": "

The unique identifier of the project item.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "fields", + "description": "

Limit results to specific fields, by their IDs. If not specified, the title field will be returned.

", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "examples": [ + "fields[]=123,fields[]=456,fields[]=789" + ] + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "user_id": "USER_ID", + "item_id": "ITEM_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 13, + "node_id": "PVTI_lAAFAQ0", + "project_url": "https://api.github.com/orgs/github/projectsV2/1", + "content": { + "url": "https://api.github.com/repos/github/Hello-World/pulls/6", + "id": 10, + "node_id": "PR_kwABCg", + "html_url": "https://github.com/github/Hello-World/pull/6", + "diff_url": "https://github.com/github/Hello-World/pull/6.diff", + "patch_url": "https://github.com/github/Hello-World/pull/6.patch", + "issue_url": "https://api.github.com/repos/github/Hello-World/issues/6", + "number": 6, + "state": "open", + "locked": false, + "title": "Issue title", + "user": { + "login": "monalisa", + "id": 161, + "node_id": "U_kgDMoQ", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "body": "Issue body", + "created_at": "2025-08-01T18:44:50Z", + "updated_at": "2025-08-06T19:25:18Z", + "closed_at": null, + "merged_at": null, + "merge_commit_sha": "98e25bad5878e54d22e5338cbc905dd2deedfa34", + "assignee": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_reviewers": [ + { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_teams": [], + "labels": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ], + "milestone": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + }, + "draft": false, + "commits_url": "https://api.github.com/repos/github/Hello-World/pulls/6/commits", + "review_comments_url": "https://api.github.com/repos/github/Hello-World/pulls/6/comments", + "review_comment_url": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/github/Hello-World/issues/6/comments", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "head": { + "label": "github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "ref": "branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "sha": "a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "base": { + "label": "github:branch-0f4ceb14cbe39e4786ffbabb776da599", + "ref": "branch-0f4ceb14cbe39e4786ffbabb776da599", + "sha": "9a9f5a8d77bdc2540412900d3c930fe36a82b5ed", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6" + }, + "html": { + "href": "https://github.com/github/Hello-World/pull/6" + }, + "issue": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6" + }, + "comments": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d" + } + }, + "author_association": "MEMBER", + "auto_merge": null, + "active_lock_reason": null + }, + "content_type": "PullRequest", + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "created_at": "2025-08-01T18:44:51Z", + "updated_at": "2025-08-06T19:25:18Z", + "archived_at": null, + "item_url": "https://api.github.com/orgs/github/projectsV2/1/items/13", + "fields": [ + { + "id": 1, + "name": "Title", + "type": "title", + "value": { + "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "number": 6, + "url": "https://github.com/5/1/pull/6", + "issue_id": 12, + "state": "open", + "state_reason": null, + "is_draft": false + } + }, + { + "id": 2, + "name": "Assignees", + "type": "assignees", + "value": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ] + }, + { + "id": 3, + "name": "Status", + "type": "single_select", + "value": { + "id": "98236657", + "name": "Done", + "name_html": "Done", + "color": "PURPLE", + "description": "This has been completed", + "description_html": "This has been completed" + } + }, + { + "id": 4, + "name": "Labels", + "type": "labels", + "value": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ] + }, + { + "id": 5, + "name": "Linked pull requests", + "type": "linked_pull_requests", + "value": [] + }, + { + "id": 6, + "name": "Milestone", + "type": "milestone", + "value": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + } + }, + { + "id": 7, + "name": "Repository", + "type": "repository", + "value": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments" + } + }, + { + "id": 8, + "name": "Type", + "type": "issue_type", + "value": null + }, + { + "id": 9, + "name": "Reviewers", + "type": "reviewers", + "value": [ + { + "type": "ReviewRequest", + "status": "pending", + "reviewer": { + "avatarUrl": "https://github.com/images/error/octocat_happy.gif", + "id": 2, + "login": "monalisa", + "url": "https://github.com/monalisa", + "name": "monalisa", + "type": "User" + } + } + ] + }, + { + "id": 10, + "name": "Parent issue", + "type": "parent_issue", + "value": null + }, + { + "id": 11, + "name": "Sub-issues progress", + "type": "sub_issues_progress", + "value": null + } + ] + }, + "schema": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "project_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the project that contains this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/3" + ] + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "content": { + "type": [ + "object", + "null" + ], + "additionalProperties": true, + "description": "The content of the item, which varies by content type." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the item was archived.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "item_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The API URL of this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/items/3" + ] + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + }, + "description": "The fields and values associated with this item." + } + }, + "required": [ + "id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Get a specific item from a user-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/users/{user_id}/projectsV2/{project_number}/items/{item_id}", + "title": "Update project item for user", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "item_id", + "description": "

The unique identifier of the project item.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "array of objects", + "name": "fields", + "in": "body", + "description": "

A list of field updates to apply.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the project field to update.

", + "isRequired": true + }, + { + "type": "null or string or number", + "name": "value", + "description": "

The new value for the field:

\n
    \n
  • For text, number, and date fields, provide the new value directly.
    • \n
  • For single select and iteration fields, provide the ID of the option or iteration.
    • \n
  • To clear the field, set this to null.
    • \n
", + "isRequired": true + } + ] + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [], + "previews": [], + "descriptionHTML": "

Update a specific item in a user-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/users/{user_id}/projectsV2/{project_number}/items/{item_id}", + "title": "Delete project item for user", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "item_id", + "description": "

The unique identifier of the project item.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "user_id": "USER_ID", + "item_id": "ITEM_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Delete a specific item from a user-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + } + ] + }, "projects-classic": { "collaborators": [ { @@ -564683,11 +575158,11 @@ }, "before_sha": { "type": "string", - "description": "The first commit sha before the push evaluation." + "description": "The previous commit SHA of the ref." }, "after_sha": { "type": "string", - "description": "The last commit sha in the push evaluation." + "description": "The new commit SHA of the ref." }, "ref": { "type": "string", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index e7234d7b58ea..dfac904e46b4 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -957,13 +957,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists artifacts for a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists artifacts for a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" + ] } ], "cache": [ @@ -1809,13 +1809,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a GitHub Actions cache for a repository, using a cache ID.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a GitHub Actions cache for a repository, using a cache ID.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] } ], "hosted-runners": [ @@ -11800,6 +11800,7 @@ } ], "previews": [], + "descriptionHTML": "

Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -11821,8 +11822,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope or the \"Actions policies\" fine-grained permission to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -15718,13 +15718,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a single repository secret without revealing its encrypted value.

\n

The authenticated user must have collaborator access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a single repository secret without revealing its encrypted value.

\n

The authenticated user must have collaborator access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -25209,13 +25209,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all self-hosted runners configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all self-hosted runners configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" + ] }, { "serverUrl": "https://api.github.com", @@ -92596,13 +92596,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all notifications for the current user in the specified repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all notifications for the current user in the specified repository.

" + ] }, { "serverUrl": "https://api.github.com", @@ -143822,6 +143822,7 @@ } ], "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", "statusCodes": [ { "httpStatusCode": "200", @@ -143835,8 +143836,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

" + ] }, { "serverUrl": "https://api.github.com", @@ -157608,13 +157608,13 @@ } ], "previews": [], + "descriptionHTML": "

Updates a check run for a specific commit in a repository.

\n

Note

\n

\nThe endpoints to manage checks only look 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
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Updates a check run for a specific commit in a repository.

\n

Note

\n

\nThe endpoints to manage checks only look 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
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -249618,6 +249618,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

", "statusCodes": [ { "httpStatusCode": "200", @@ -249627,8 +249628,7 @@ "httpStatusCode": "409", "description": "

Conflict

" } - ], - "descriptionHTML": "

Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.

\n

To list the open or merged pull requests associated with a branch, you can set the commit_sha parameter to the branch name.

" + ] }, { "serverUrl": "https://api.github.com", @@ -274256,13 +274256,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all secrets available in a repository without revealing their encrypted\nvalues.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all secrets available in a repository without revealing their encrypted\nvalues.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "https://api.github.com", @@ -275597,6 +275597,7 @@ } ], "previews": [], + "descriptionHTML": "

Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.

", "statusCodes": [ { "httpStatusCode": "200", @@ -275610,8 +275611,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.

" + ] } ] }, @@ -279438,13 +279438,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a deployment branch or tag policy for an environment.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a deployment branch or tag policy for an environment.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" + ] }, { "serverUrl": "https://api.github.com", @@ -368166,6 +368166,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists events for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -368175,8 +368176,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Lists events for a repository.

" + ] }, { "serverUrl": "https://api.github.com", @@ -476478,11 +476478,11 @@ }, "before_sha": { "type": "string", - "description": "The first commit sha before the push evaluation." + "description": "The previous commit SHA of the ref." }, "after_sha": { "type": "string", - "description": "The last commit sha in the push evaluation." + "description": "The new commit SHA of the ref." }, "ref": { "type": "string", @@ -490861,13 +490861,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific package in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific package in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

" + ] }, { "serverUrl": "https://api.github.com", @@ -504939,27 +504939,74 @@ } ] }, - "projects-classic": { - "cards": [ + "projects": { + "projects": [ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Get a project card", - "category": "projects-classic", - "subcategory": "cards", + "requestPath": "/orgs/{org}/projectsV2", + "title": "List projects for organization", + "category": "projects", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "q", + "description": "

Limit results to projects of the specified type.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 } } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", @@ -504967,7 +505014,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "card_id": "CARD_ID" + "org": "ORG" } }, "response": { @@ -504975,11 +505022,9 @@ "contentType": "application/json", "description": "

Response

", "example": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { + "id": 2, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -504999,367 +505044,6 @@ "type": "User", "site_admin": false }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - }, - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/cards/1478" - ] - }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" - ] - }, - "note": { - "type": [ - "string", - "null" - ], - "examples": [ - "Add payload for delete Project column" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:21:06Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:20:22Z" - ] - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", - "examples": [ - false - ] - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "content_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "patch", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Update an existing project card", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "card_id", - "description": "

The unique identifier of the card.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string or null", - "name": "note", - "in": "body", - "description": "

The project card's note

" - }, - { - "type": "boolean", - "name": "archived", - "in": "body", - "description": "

Whether or not the card is archived

" - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Change the note on the card", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "note": "Add payload for delete Project column" - }, - "parameters": { - "card_id": "CARD_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", "creator": { "login": "octocat", "id": 1, @@ -505380,604 +505064,11395 @@ "type": "User", "site_admin": false }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - }, - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/cards/1478" - ] - }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" - ] - }, - "note": { - "type": [ - "string", - "null" - ], - "examples": [ - "Add payload for delete Project column" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:21:06Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:20:22Z" - ] - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", - "examples": [ - false - ] - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "content_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Delete a project card", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "card_id", - "description": "

The unique identifier of the card.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "card_id": "CARD_ID" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

" - } - } - ], - "previews": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "

No Content

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "404", - "description": "

Resource not found

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/projects/columns/cards/{card_id}/moves", - "title": "Move a project card", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "card_id", - "description": "

The unique identifier of the card.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "position", - "in": "body", - "description": "

The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

", - "isRequired": true - }, - { - "type": "integer", - "name": "column_id", - "in": "body", - "description": "

The unique identifier of the column the card should be moved to

" - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Move the card to the bottom of the column", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "column_id": 42, - "position": "bottom" - }, - "parameters": { - "card_id": "CARD_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": null, - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "previews": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "

Created

" - }, - { - "httpStatusCode": "304", - "description": "

Not modified

" - }, - { - "httpStatusCode": "401", - "description": "

Requires authentication

" - }, - { - "httpStatusCode": "403", - "description": "

Forbidden

" - }, - { - "httpStatusCode": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - }, - { - "httpStatusCode": "503", - "description": "

Service Unavailable

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "List project cards", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "archived_state", - "description": "

Filters the project cards that are returned by the card's state.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "archived", - "not_archived" - ], - "default": "not_archived" - } - }, - { - "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "column_id": "COLUMN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", + "title": "My Projects", + "description": "A board to manage my personal projects.", + "public": true, + "closed_at": null, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "number": 2, + "short_description": null, + "deleted_at": null, + "deleted_by": null, + "state": "open", + "latest_status_update": { + "id": 3, + "node_id": "PVTSU_lAECAQM", "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "login": "hubot", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/hubot_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", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", "type": "User", "site_admin": false }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - ], + "body": "DONE", + "start_date": "2025-07-23", + "target_date": "2025-07-26", + "status": "COMPLETE", + "created_at": "2025-07-11T16:19:28Z", + "updated_at": "2025-07-11T16:19:28Z" + }, + "is_template": true + }, "schema": { "type": "array", "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Projects v2 Project", + "description": "A projects v2 project", "type": "object", "properties": { - "url": { + "id": { + "type": "number", + "description": "The unique identifier of the project." + }, + "node_id": { "type": "string", - "format": "uri", + "description": "The node ID of the project." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "title": { + "type": "string", + "description": "The project title." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A short description of the project." + }, + "public": { + "type": "boolean", + "description": "Whether the project is visible to anyone with access to the owner." + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was closed.", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "2022-04-28T12:00:00Z" ] }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64", + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was created.", "examples": [ - 42 + "2022-04-28T12:00:00Z" ] }, - "node_id": { + "updated_at": { "type": "string", + "format": "date-time", + "description": "The time when the project was last updated.", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "2022-04-28T12:00:00Z" ] }, - "note": { + "number": { + "type": "integer", + "description": "The project number." + }, + "short_description": { "type": [ "string", "null" ], + "description": "A concise summary of the project." + }, + "deleted_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was deleted.", "examples": [ - "Add payload for delete Project column" + "2022-04-28T12:00:00Z" ] }, - "creator": { + "deleted_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + } + ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ], + "description": "The current state of the project." + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the status update." + }, + "node_id": { + "type": "string", + "description": "The node ID of the status update." + }, + "project_node_id": { + "type": "string", + "description": "The node ID of the project that this status update belongs to." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ], + "description": "The current status." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the period covered by the update.", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "description": "The target date associated with the update.", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" + } + }, + "required": [ + "id", + "node_id", + "owner", + "creator", + "title", + "description", + "public", + "closed_at", + "created_at", + "updated_at", + "number", + "short_description", + "deleted_at", + "deleted_by" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

List all projects owned by a specific organization accessible by the authenticated user.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}", + "title": "Get project for organization", + "category": "projects", + "subcategory": "projects", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 2, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "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 + }, + "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 + }, + "title": "My Projects", + "description": "A board to manage my personal projects.", + "public": true, + "closed_at": null, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "number": 2, + "short_description": null, + "deleted_at": null, + "deleted_by": null, + "state": "open", + "latest_status_update": { + "id": 3, + "node_id": "PVTSU_lAECAQM", + "creator": { + "login": "hubot", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": false + }, + "body": "DONE", + "start_date": "2025-07-23", + "target_date": "2025-07-26", + "status": "COMPLETE", + "created_at": "2025-07-11T16:19:28Z", + "updated_at": "2025-07-11T16:19:28Z" + }, + "is_template": true + }, + "schema": { + "title": "Projects v2 Project", + "description": "A projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "title": { + "type": "string", + "description": "The project title." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A short description of the project." + }, + "public": { + "type": "boolean", + "description": "Whether the project is visible to anyone with access to the owner." + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was closed.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "number": { + "type": "integer", + "description": "The project number." + }, + "short_description": { + "type": [ + "string", + "null" + ], + "description": "A concise summary of the project." + }, + "deleted_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was deleted.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "deleted_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + } + ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ], + "description": "The current state of the project." + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the status update." + }, + "node_id": { + "type": "string", + "description": "The node ID of the status update." + }, + "project_node_id": { + "type": "string", + "description": "The node ID of the project that this status update belongs to." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ], + "description": "The current status." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the period covered by the update.", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "description": "The target date associated with the update.", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" + } + }, + "required": [ + "id", + "node_id", + "owner", + "creator", + "title", + "description", + "public", + "closed_at", + "created_at", + "updated_at", + "number", + "short_description", + "deleted_at", + "deleted_by" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Get a specific organization-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{user_id}/projectsV2/{project_number}", + "title": "Get project for user", + "category": "projects", + "subcategory": "projects", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "user_id": "USER_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 2, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "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 + }, + "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 + }, + "title": "My Projects", + "description": "A board to manage my personal projects.", + "public": true, + "closed_at": null, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "number": 2, + "short_description": null, + "deleted_at": null, + "deleted_by": null, + "state": "open", + "latest_status_update": { + "id": 3, + "node_id": "PVTSU_lAECAQM", + "creator": { + "login": "hubot", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": false + }, + "body": "DONE", + "start_date": "2025-07-23", + "target_date": "2025-07-26", + "status": "COMPLETE", + "created_at": "2025-07-11T16:19:28Z", + "updated_at": "2025-07-11T16:19:28Z" + }, + "is_template": true + }, + "schema": { + "title": "Projects v2 Project", + "description": "A projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "title": { + "type": "string", + "description": "The project title." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A short description of the project." + }, + "public": { + "type": "boolean", + "description": "Whether the project is visible to anyone with access to the owner." + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was closed.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "number": { + "type": "integer", + "description": "The project number." + }, + "short_description": { + "type": [ + "string", + "null" + ], + "description": "A concise summary of the project." + }, + "deleted_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was deleted.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "deleted_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + } + ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ], + "description": "The current state of the project." + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the status update." + }, + "node_id": { + "type": "string", + "description": "The node ID of the status update." + }, + "project_node_id": { + "type": "string", + "description": "The node ID of the project that this status update belongs to." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ], + "description": "The current status." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the period covered by the update.", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "description": "The target date associated with the update.", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" + } + }, + "required": [ + "id", + "node_id", + "owner", + "creator", + "title", + "description", + "public", + "closed_at", + "created_at", + "updated_at", + "number", + "short_description", + "deleted_at", + "deleted_by" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Get a specific user-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/projectsV2", + "title": "List projects for user", + "category": "projects", + "subcategory": "projects", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "q", + "description": "

Limit results to projects of the specified type.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 2, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "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 + }, + "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 + }, + "title": "My Projects", + "description": "A board to manage my personal projects.", + "public": true, + "closed_at": null, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "number": 2, + "short_description": null, + "deleted_at": null, + "deleted_by": null, + "state": "open", + "latest_status_update": { + "id": 3, + "node_id": "PVTSU_lAECAQM", + "creator": { + "login": "hubot", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": false + }, + "body": "DONE", + "start_date": "2025-07-23", + "target_date": "2025-07-26", + "status": "COMPLETE", + "created_at": "2025-07-11T16:19:28Z", + "updated_at": "2025-07-11T16:19:28Z" + }, + "is_template": true + }, + "schema": { + "type": "array", + "items": { + "title": "Projects v2 Project", + "description": "A projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "title": { + "type": "string", + "description": "The project title." + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "A short description of the project." + }, + "public": { + "type": "boolean", + "description": "Whether the project is visible to anyone with access to the owner." + }, + "closed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was closed.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the project was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "number": { + "type": "integer", + "description": "The project number." + }, + "short_description": { + "type": [ + "string", + "null" + ], + "description": "A concise summary of the project." + }, + "deleted_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the project was deleted.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "deleted_by": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + } + ] + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ], + "description": "The current state of the project." + }, + "latest_status_update": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the status update." + }, + "node_id": { + "type": "string", + "description": "The node ID of the status update." + }, + "project_node_id": { + "type": "string", + "description": "The node ID of the project that this status update belongs to." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the status update was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "status": { + "type": [ + "string", + "null" + ], + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE", + null + ], + "description": "The current status." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the period covered by the update.", + "examples": [ + "2022-04-28" + ] + }, + "target_date": { + "type": "string", + "format": "date", + "description": "The target date associated with the update.", + "examples": [ + "2022-04-28" + ] + }, + "body": { + "description": "Body of the status update", + "type": [ + "string", + "null" + ], + "examples": [ + "The project is off to a great start!" + ] + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + } + ] + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" + } + }, + "required": [ + "id", + "node_id", + "owner", + "creator", + "title", + "description", + "public", + "closed_at", + "created_at", + "updated_at", + "number", + "short_description", + "deleted_at", + "deleted_by" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

List all projects owned by a specific user accessible by the authenticated user.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + } + ], + "fields": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields", + "title": "List project fields for organization", + "category": "projects", + "subcategory": "fields", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": "Low", + "color": "GREEN", + "description": "Low priority items" + }, + { + "id": "option_2", + "name": "Medium", + "color": "YELLOW", + "description": "Medium priority items" + }, + { + "id": "option_3", + "name": "High", + "color": "RED", + "description": "High priority items" + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + "schema": { + "type": "array", + "items": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

List all fields for a specific organization-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}", + "title": "Get project field for organization", + "category": "projects", + "subcategory": "fields", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "

The unique identifier of the field.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "field_id": "FIELD_ID", + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": "Low", + "color": "GREEN", + "description": "Low priority items" + }, + { + "id": "option_2", + "name": "Medium", + "color": "YELLOW", + "description": "Medium priority items" + }, + { + "id": "option_3", + "name": "High", + "color": "RED", + "description": "High priority items" + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Get a specific field for an organization-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{user_id}/projectsV2/{project_number}/fields", + "title": "List project fields for user", + "category": "projects", + "subcategory": "fields", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "user_id": "USER_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": "Low", + "color": "GREEN", + "description": "Low priority items" + }, + { + "id": "option_2", + "name": "Medium", + "color": "YELLOW", + "description": "Medium priority items" + }, + { + "id": "option_3", + "name": "High", + "color": "RED", + "description": "High priority items" + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + "schema": { + "type": "array", + "items": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

List all fields for a specific user-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{user_id}/projectsV2/{project_number}/fields/{field_id}", + "title": "Get project field for user", + "category": "projects", + "subcategory": "fields", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "

The unique identifier of the field.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "field_id": "FIELD_ID", + "user_id": "USER_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": "Low", + "color": "GREEN", + "description": "Low priority items" + }, + { + "id": "option_2", + "name": "Medium", + "color": "YELLOW", + "description": "Medium priority items" + }, + { + "id": "option_3", + "name": "High", + "color": "RED", + "description": "High priority items" + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Get a specific field for a user-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + } + ], + "items": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items", + "title": "List items for an organization owned project", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "q", + "description": "

Search query to filter items, see Filtering projects for more information.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "fields", + "description": "

Limit results to specific fields, by their IDs. If not specified, the title field will be returned.

", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "examples": [ + "fields[]=123,fields[]=456,fields[]=789" + ] + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 13, + "node_id": "PVTI_lAAFAQ0", + "project_url": "https://api.github.com/orgs/github/projectsV2/1", + "content": { + "url": "https://api.github.com/repos/github/Hello-World/pulls/6", + "id": 10, + "node_id": "PR_kwABCg", + "html_url": "https://github.com/github/Hello-World/pull/6", + "diff_url": "https://github.com/github/Hello-World/pull/6.diff", + "patch_url": "https://github.com/github/Hello-World/pull/6.patch", + "issue_url": "https://api.github.com/repos/github/Hello-World/issues/6", + "number": 6, + "state": "open", + "locked": false, + "title": "Issue title", + "user": { + "login": "monalisa", + "id": 161, + "node_id": "U_kgDMoQ", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "body": "Issue body", + "created_at": "2025-08-01T18:44:50Z", + "updated_at": "2025-08-06T19:25:18Z", + "closed_at": null, + "merged_at": null, + "merge_commit_sha": "98e25bad5878e54d22e5338cbc905dd2deedfa34", + "assignee": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_reviewers": [ + { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_teams": [], + "labels": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ], + "milestone": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + }, + "draft": false, + "commits_url": "https://api.github.com/repos/github/Hello-World/pulls/6/commits", + "review_comments_url": "https://api.github.com/repos/github/Hello-World/pulls/6/comments", + "review_comment_url": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/github/Hello-World/issues/6/comments", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "head": { + "label": "github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "ref": "branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "sha": "a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "base": { + "label": "github:branch-0f4ceb14cbe39e4786ffbabb776da599", + "ref": "branch-0f4ceb14cbe39e4786ffbabb776da599", + "sha": "9a9f5a8d77bdc2540412900d3c930fe36a82b5ed", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6" + }, + "html": { + "href": "https://github.com/github/Hello-World/pull/6" + }, + "issue": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6" + }, + "comments": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d" + } + }, + "author_association": "MEMBER", + "auto_merge": null, + "active_lock_reason": null + }, + "content_type": "PullRequest", + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "created_at": "2025-08-01T18:44:51Z", + "updated_at": "2025-08-06T19:25:18Z", + "archived_at": null, + "item_url": "https://api.github.com/orgs/github/projectsV2/1/items/13", + "fields": [ + { + "id": 1, + "name": "Title", + "type": "title", + "value": { + "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "number": 6, + "url": "https://github.com/5/1/pull/6", + "issue_id": 12, + "state": "open", + "state_reason": null, + "is_draft": false + } + }, + { + "id": 2, + "name": "Assignees", + "type": "assignees", + "value": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ] + }, + { + "id": 3, + "name": "Status", + "type": "single_select", + "value": { + "id": "98236657", + "name": "Done", + "name_html": "Done", + "color": "PURPLE", + "description": "This has been completed", + "description_html": "This has been completed" + } + }, + { + "id": 4, + "name": "Labels", + "type": "labels", + "value": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ] + }, + { + "id": 5, + "name": "Linked pull requests", + "type": "linked_pull_requests", + "value": [] + }, + { + "id": 6, + "name": "Milestone", + "type": "milestone", + "value": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + } + }, + { + "id": 7, + "name": "Repository", + "type": "repository", + "value": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments" + } + }, + { + "id": 8, + "name": "Type", + "type": "issue_type", + "value": null + }, + { + "id": 9, + "name": "Reviewers", + "type": "reviewers", + "value": [ + { + "type": "ReviewRequest", + "status": "pending", + "reviewer": { + "avatarUrl": "https://github.com/images/error/octocat_happy.gif", + "id": 2, + "login": "monalisa", + "url": "https://github.com/monalisa", + "name": "monalisa", + "type": "User" + } + } + ] + }, + { + "id": 10, + "name": "Parent issue", + "type": "parent_issue", + "value": null + }, + { + "id": 11, + "name": "Sub-issues progress", + "type": "sub_issues_progress", + "value": null + } + ] + }, + "schema": { + "type": "array", + "items": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "project_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the project that contains this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/3" + ] + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "content": { + "type": [ + "object", + "null" + ], + "additionalProperties": true, + "description": "The content of the item, which varies by content type." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the item was archived.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "item_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The API URL of this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/items/3" + ] + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + }, + "description": "The fields and values associated with this item." + } + }, + "required": [ + "id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

List all items for a specific organization-owned project accessible by the authenticated user.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items", + "title": "Add item to organization owned project", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "type", + "in": "body", + "description": "

The type of item to add to the project. Must be either Issue or PullRequest.

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest" + ] + }, + { + "type": "integer", + "name": "id", + "in": "body", + "description": "

The numeric ID of the issue or pull request to add to the project.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [], + "previews": [], + "descriptionHTML": "

Add an issue or pull request item to the specified organization owned project.

", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "title": "Get an item for an organization owned project", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "item_id", + "description": "

The unique identifier of the project item.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "fields", + "description": "

Limit results to specific fields, by their IDs. If not specified, the title field will be returned.

", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "examples": [ + "fields[]=123,fields[]=456,fields[]=789" + ] + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG", + "item_id": "ITEM_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 13, + "node_id": "PVTI_lAAFAQ0", + "project_url": "https://api.github.com/orgs/github/projectsV2/1", + "content": { + "url": "https://api.github.com/repos/github/Hello-World/pulls/6", + "id": 10, + "node_id": "PR_kwABCg", + "html_url": "https://github.com/github/Hello-World/pull/6", + "diff_url": "https://github.com/github/Hello-World/pull/6.diff", + "patch_url": "https://github.com/github/Hello-World/pull/6.patch", + "issue_url": "https://api.github.com/repos/github/Hello-World/issues/6", + "number": 6, + "state": "open", + "locked": false, + "title": "Issue title", + "user": { + "login": "monalisa", + "id": 161, + "node_id": "U_kgDMoQ", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "body": "Issue body", + "created_at": "2025-08-01T18:44:50Z", + "updated_at": "2025-08-06T19:25:18Z", + "closed_at": null, + "merged_at": null, + "merge_commit_sha": "98e25bad5878e54d22e5338cbc905dd2deedfa34", + "assignee": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_reviewers": [ + { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_teams": [], + "labels": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ], + "milestone": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + }, + "draft": false, + "commits_url": "https://api.github.com/repos/github/Hello-World/pulls/6/commits", + "review_comments_url": "https://api.github.com/repos/github/Hello-World/pulls/6/comments", + "review_comment_url": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/github/Hello-World/issues/6/comments", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "head": { + "label": "github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "ref": "branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "sha": "a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "base": { + "label": "github:branch-0f4ceb14cbe39e4786ffbabb776da599", + "ref": "branch-0f4ceb14cbe39e4786ffbabb776da599", + "sha": "9a9f5a8d77bdc2540412900d3c930fe36a82b5ed", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6" + }, + "html": { + "href": "https://github.com/github/Hello-World/pull/6" + }, + "issue": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6" + }, + "comments": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d" + } + }, + "author_association": "MEMBER", + "auto_merge": null, + "active_lock_reason": null + }, + "content_type": "PullRequest", + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "created_at": "2025-08-01T18:44:51Z", + "updated_at": "2025-08-06T19:25:18Z", + "archived_at": null, + "item_url": "https://api.github.com/orgs/github/projectsV2/1/items/13", + "fields": [ + { + "id": 1, + "name": "Title", + "type": "title", + "value": { + "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "number": 6, + "url": "https://github.com/5/1/pull/6", + "issue_id": 12, + "state": "open", + "state_reason": null, + "is_draft": false + } + }, + { + "id": 2, + "name": "Assignees", + "type": "assignees", + "value": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ] + }, + { + "id": 3, + "name": "Status", + "type": "single_select", + "value": { + "id": "98236657", + "name": "Done", + "name_html": "Done", + "color": "PURPLE", + "description": "This has been completed", + "description_html": "This has been completed" + } + }, + { + "id": 4, + "name": "Labels", + "type": "labels", + "value": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ] + }, + { + "id": 5, + "name": "Linked pull requests", + "type": "linked_pull_requests", + "value": [] + }, + { + "id": 6, + "name": "Milestone", + "type": "milestone", + "value": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + } + }, + { + "id": 7, + "name": "Repository", + "type": "repository", + "value": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments" + } + }, + { + "id": 8, + "name": "Type", + "type": "issue_type", + "value": null + }, + { + "id": 9, + "name": "Reviewers", + "type": "reviewers", + "value": [ + { + "type": "ReviewRequest", + "status": "pending", + "reviewer": { + "avatarUrl": "https://github.com/images/error/octocat_happy.gif", + "id": 2, + "login": "monalisa", + "url": "https://github.com/monalisa", + "name": "monalisa", + "type": "User" + } + } + ] + }, + { + "id": 10, + "name": "Parent issue", + "type": "parent_issue", + "value": null + }, + { + "id": 11, + "name": "Sub-issues progress", + "type": "sub_issues_progress", + "value": null + } + ] + }, + "schema": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "project_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the project that contains this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/3" + ] + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "content": { + "type": [ + "object", + "null" + ], + "additionalProperties": true, + "description": "The content of the item, which varies by content type." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the item was archived.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "item_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The API URL of this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/items/3" + ] + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + }, + "description": "The fields and values associated with this item." + } + }, + "required": [ + "id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Get a specific item from an organization-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "title": "Update project item for organization", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "item_id", + "description": "

The unique identifier of the project item.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "array of objects", + "name": "fields", + "in": "body", + "description": "

A list of field updates to apply.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the project field to update.

", + "isRequired": true + }, + { + "type": "null or string or number", + "name": "value", + "description": "

The new value for the field:

\n
    \n
  • For text, number, and date fields, provide the new value directly.
    • \n
  • For single select and iteration fields, provide the ID of the option or iteration.
    • \n
  • To clear the field, set this to null.
    • \n
", + "isRequired": true + } + ] + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [], + "previews": [], + "descriptionHTML": "

Update a specific item in an organization-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}", + "title": "Delete project item for organization", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "item_id", + "description": "

The unique identifier of the project item.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG", + "item_id": "ITEM_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Delete a specific item from an organization-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{user_id}/projectsV2/{project_number}/items", + "title": "List items for a user owned project", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "before", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "q", + "description": "

Search query to filter items, see Filtering projects for more information.

", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "fields", + "description": "

Limit results to specific fields, by their IDs. If not specified, the title field will be returned.

", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "examples": [ + "fields[]=123,fields[]=456,fields[]=789" + ] + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "user_id": "USER_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 13, + "node_id": "PVTI_lAAFAQ0", + "project_url": "https://api.github.com/orgs/github/projectsV2/1", + "content": { + "url": "https://api.github.com/repos/github/Hello-World/pulls/6", + "id": 10, + "node_id": "PR_kwABCg", + "html_url": "https://github.com/github/Hello-World/pull/6", + "diff_url": "https://github.com/github/Hello-World/pull/6.diff", + "patch_url": "https://github.com/github/Hello-World/pull/6.patch", + "issue_url": "https://api.github.com/repos/github/Hello-World/issues/6", + "number": 6, + "state": "open", + "locked": false, + "title": "Issue title", + "user": { + "login": "monalisa", + "id": 161, + "node_id": "U_kgDMoQ", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "body": "Issue body", + "created_at": "2025-08-01T18:44:50Z", + "updated_at": "2025-08-06T19:25:18Z", + "closed_at": null, + "merged_at": null, + "merge_commit_sha": "98e25bad5878e54d22e5338cbc905dd2deedfa34", + "assignee": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_reviewers": [ + { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_teams": [], + "labels": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ], + "milestone": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + }, + "draft": false, + "commits_url": "https://api.github.com/repos/github/Hello-World/pulls/6/commits", + "review_comments_url": "https://api.github.com/repos/github/Hello-World/pulls/6/comments", + "review_comment_url": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/github/Hello-World/issues/6/comments", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "head": { + "label": "github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "ref": "branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "sha": "a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "base": { + "label": "github:branch-0f4ceb14cbe39e4786ffbabb776da599", + "ref": "branch-0f4ceb14cbe39e4786ffbabb776da599", + "sha": "9a9f5a8d77bdc2540412900d3c930fe36a82b5ed", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6" + }, + "html": { + "href": "https://github.com/github/Hello-World/pull/6" + }, + "issue": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6" + }, + "comments": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d" + } + }, + "author_association": "MEMBER", + "auto_merge": null, + "active_lock_reason": null + }, + "content_type": "PullRequest", + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "created_at": "2025-08-01T18:44:51Z", + "updated_at": "2025-08-06T19:25:18Z", + "archived_at": null, + "item_url": "https://api.github.com/orgs/github/projectsV2/1/items/13", + "fields": [ + { + "id": 1, + "name": "Title", + "type": "title", + "value": { + "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "number": 6, + "url": "https://github.com/5/1/pull/6", + "issue_id": 12, + "state": "open", + "state_reason": null, + "is_draft": false + } + }, + { + "id": 2, + "name": "Assignees", + "type": "assignees", + "value": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ] + }, + { + "id": 3, + "name": "Status", + "type": "single_select", + "value": { + "id": "98236657", + "name": "Done", + "name_html": "Done", + "color": "PURPLE", + "description": "This has been completed", + "description_html": "This has been completed" + } + }, + { + "id": 4, + "name": "Labels", + "type": "labels", + "value": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ] + }, + { + "id": 5, + "name": "Linked pull requests", + "type": "linked_pull_requests", + "value": [] + }, + { + "id": 6, + "name": "Milestone", + "type": "milestone", + "value": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + } + }, + { + "id": 7, + "name": "Repository", + "type": "repository", + "value": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments" + } + }, + { + "id": 8, + "name": "Type", + "type": "issue_type", + "value": null + }, + { + "id": 9, + "name": "Reviewers", + "type": "reviewers", + "value": [ + { + "type": "ReviewRequest", + "status": "pending", + "reviewer": { + "avatarUrl": "https://github.com/images/error/octocat_happy.gif", + "id": 2, + "login": "monalisa", + "url": "https://github.com/monalisa", + "name": "monalisa", + "type": "User" + } + } + ] + }, + { + "id": 10, + "name": "Parent issue", + "type": "parent_issue", + "value": null + }, + { + "id": 11, + "name": "Sub-issues progress", + "type": "sub_issues_progress", + "value": null + } + ] + }, + "schema": { + "type": "array", + "items": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "project_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the project that contains this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/3" + ] + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "content": { + "type": [ + "object", + "null" + ], + "additionalProperties": true, + "description": "The content of the item, which varies by content type." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the item was archived.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "item_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The API URL of this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/items/3" + ] + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + }, + "description": "The fields and values associated with this item." + } + }, + "required": [ + "id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

List all items for a specific user-owned project accessible by the authenticated user.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{user_id}/projectsV2/{project_number}/items", + "title": "Add item to user owned project", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "type", + "in": "body", + "description": "

The type of item to add to the project. Must be either Issue or PullRequest.

", + "isRequired": true, + "enum": [ + "Issue", + "PullRequest" + ] + }, + { + "type": "integer", + "name": "id", + "in": "body", + "description": "

The numeric ID of the issue or pull request to add to the project.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [], + "previews": [], + "descriptionHTML": "

Add an issue or pull request item to the specified user owned project.

", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{user_id}/projectsV2/{project_number}/items/{item_id}", + "title": "Get an item for a user owned project", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "item_id", + "description": "

The unique identifier of the project item.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "fields", + "description": "

Limit results to specific fields, by their IDs. If not specified, the title field will be returned.

", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "examples": [ + "fields[]=123,fields[]=456,fields[]=789" + ] + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "user_id": "USER_ID", + "item_id": "ITEM_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "id": 13, + "node_id": "PVTI_lAAFAQ0", + "project_url": "https://api.github.com/orgs/github/projectsV2/1", + "content": { + "url": "https://api.github.com/repos/github/Hello-World/pulls/6", + "id": 10, + "node_id": "PR_kwABCg", + "html_url": "https://github.com/github/Hello-World/pull/6", + "diff_url": "https://github.com/github/Hello-World/pull/6.diff", + "patch_url": "https://github.com/github/Hello-World/pull/6.patch", + "issue_url": "https://api.github.com/repos/github/Hello-World/issues/6", + "number": 6, + "state": "open", + "locked": false, + "title": "Issue title", + "user": { + "login": "monalisa", + "id": 161, + "node_id": "U_kgDMoQ", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "body": "Issue body", + "created_at": "2025-08-01T18:44:50Z", + "updated_at": "2025-08-06T19:25:18Z", + "closed_at": null, + "merged_at": null, + "merge_commit_sha": "98e25bad5878e54d22e5338cbc905dd2deedfa34", + "assignee": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_reviewers": [ + { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_teams": [], + "labels": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ], + "milestone": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + }, + "draft": false, + "commits_url": "https://api.github.com/repos/github/Hello-World/pulls/6/commits", + "review_comments_url": "https://api.github.com/repos/github/Hello-World/pulls/6/comments", + "review_comment_url": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/github/Hello-World/issues/6/comments", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "head": { + "label": "github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "ref": "branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "sha": "a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "base": { + "label": "github:branch-0f4ceb14cbe39e4786ffbabb776da599", + "ref": "branch-0f4ceb14cbe39e4786ffbabb776da599", + "sha": "9a9f5a8d77bdc2540412900d3c930fe36a82b5ed", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6" + }, + "html": { + "href": "https://github.com/github/Hello-World/pull/6" + }, + "issue": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6" + }, + "comments": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d" + } + }, + "author_association": "MEMBER", + "auto_merge": null, + "active_lock_reason": null + }, + "content_type": "PullRequest", + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "created_at": "2025-08-01T18:44:51Z", + "updated_at": "2025-08-06T19:25:18Z", + "archived_at": null, + "item_url": "https://api.github.com/orgs/github/projectsV2/1/items/13", + "fields": [ + { + "id": 1, + "name": "Title", + "type": "title", + "value": { + "raw_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html_title": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "number": 6, + "url": "https://github.com/5/1/pull/6", + "issue_id": 12, + "state": "open", + "state_reason": null, + "is_draft": false + } + }, + { + "id": 2, + "name": "Assignees", + "type": "assignees", + "value": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + } + ] + }, + { + "id": 3, + "name": "Status", + "type": "single_select", + "value": { + "id": "98236657", + "name": "Done", + "name_html": "Done", + "color": "PURPLE", + "description": "This has been completed", + "description_html": "This has been completed" + } + }, + { + "id": 4, + "name": "Labels", + "type": "labels", + "value": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ] + }, + { + "id": 5, + "name": "Linked pull requests", + "type": "linked_pull_requests", + "value": [] + }, + { + "id": 6, + "name": "Milestone", + "type": "milestone", + "value": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "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", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + } + }, + { + "id": 7, + "name": "Repository", + "type": "repository", + "value": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments" + } + }, + { + "id": 8, + "name": "Type", + "type": "issue_type", + "value": null + }, + { + "id": 9, + "name": "Reviewers", + "type": "reviewers", + "value": [ + { + "type": "ReviewRequest", + "status": "pending", + "reviewer": { + "avatarUrl": "https://github.com/images/error/octocat_happy.gif", + "id": 2, + "login": "monalisa", + "url": "https://github.com/monalisa", + "name": "monalisa", + "type": "User" + } + } + ] + }, + { + "id": 10, + "name": "Parent issue", + "type": "parent_issue", + "value": null + }, + { + "id": 11, + "name": "Sub-issues progress", + "type": "sub_issues_progress", + "value": null + } + ] + }, + "schema": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "project_url": { + "type": "string", + "format": "uri", + "description": "The API URL of the project that contains this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/3" + ] + }, + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "content": { + "type": [ + "object", + "null" + ], + "additionalProperties": true, + "description": "The content of the item, which varies by content type." + }, + "creator": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the item was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time when the item was archived.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "item_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The API URL of this item.", + "examples": [ + "https://api.github.com/users/monalisa/2/projectsV2/items/3" + ] + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + }, + "description": "The fields and values associated with this item." + } + }, + "required": [ + "id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Get a specific item from a user-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/users/{user_id}/projectsV2/{project_number}/items/{item_id}", + "title": "Update project item for user", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "item_id", + "description": "

The unique identifier of the project item.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "array of objects", + "name": "fields", + "in": "body", + "description": "

A list of field updates to apply.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "

The ID of the project field to update.

", + "isRequired": true + }, + { + "type": "null or string or number", + "name": "value", + "description": "

The new value for the field:

\n
    \n
  • For text, number, and date fields, provide the new value directly.
    • \n
  • For single select and iteration fields, provide the ID of the option or iteration.
    • \n
  • To clear the field, set this to null.
    • \n
", + "isRequired": true + } + ] + } + ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [], + "previews": [], + "descriptionHTML": "

Update a specific item in a user-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/users/{user_id}/projectsV2/{project_number}/items/{item_id}", + "title": "Delete project item for user", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "

The project's number.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "user_id", + "description": "

The unique identifier of the user.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "item_id", + "description": "

The unique identifier of the project item.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "user_id": "USER_ID", + "item_id": "ITEM_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Delete a specific item from a user-owned project.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + } + ] + } + ] + }, + "projects-classic": { + "cards": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Get a project card", + "category": "projects-classic", + "subcategory": "cards", + "parameters": [ + { + "name": "card_id", + "description": "

The unique identifier of the card.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "card_id": "CARD_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "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": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + }, + "schema": { + "title": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/cards/1478" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOlByb2plY3RDYXJkMTQ3OA==" + ] + }, + "note": { + "type": [ + "string", + "null" + ], + "examples": [ + "Add payload for delete Project column" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:21:06Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:20:22Z" + ] + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean", + "examples": [ + false + ] + }, + "column_name": { + "type": "string" + }, + "project_id": { + "type": "string" + }, + "column_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "content_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test/issues/3" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + } + }, + "required": [ + "id", + "node_id", + "note", + "url", + "column_url", + "project_url", + "creator", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Update an existing project card", + "category": "projects-classic", + "subcategory": "cards", + "parameters": [ + { + "name": "card_id", + "description": "

The unique identifier of the card.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string or null", + "name": "note", + "in": "body", + "description": "

The project card's note

" + }, + { + "type": "boolean", + "name": "archived", + "in": "body", + "description": "

Whether or not the card is archived

" + } + ], + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Change the note on the card", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "note": "Add payload for delete Project column" + }, + "parameters": { + "card_id": "CARD_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "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": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + }, + "schema": { + "title": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/cards/1478" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOlByb2plY3RDYXJkMTQ3OA==" + ] + }, + "note": { + "type": [ + "string", + "null" + ], + "examples": [ + "Add payload for delete Project column" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "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" + ] + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:21:06Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:20:22Z" + ] + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean", + "examples": [ + false + ] + }, + "column_name": { + "type": "string" + }, + "project_id": { + "type": "string" + }, + "column_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "content_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test/issues/3" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + } + }, + "required": [ + "id", + "node_id", + "note", + "url", + "column_url", + "project_url", + "creator", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Delete a project card", + "category": "projects-classic", + "subcategory": "cards", + "parameters": [ + { + "name": "card_id", + "description": "

The unique identifier of the card.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "card_id": "CARD_ID" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

" + } + } + ], + "previews": [], + "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "title": "Move a project card", + "category": "projects-classic", + "subcategory": "cards", + "parameters": [ + { + "name": "card_id", + "description": "

The unique identifier of the card.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "position", + "in": "body", + "description": "

The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.

", + "isRequired": true + }, + { + "type": "integer", + "name": "column_id", + "in": "body", + "description": "

The unique identifier of the column the card should be moved to

" + } + ], + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Move the card to the bottom of the column", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "column_id": 42, + "position": "bottom" + }, + "parameters": { + "card_id": "CARD_ID" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": null, + "schema": { + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + } + ], + "previews": [], + "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "

Created

" + }, + { + "httpStatusCode": "304", + "description": "

Not modified

" + }, + { + "httpStatusCode": "401", + "description": "

Requires authentication

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed, or the endpoint has been spammed.

" + }, + { + "httpStatusCode": "503", + "description": "

Service Unavailable

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "title": "List project cards", + "category": "projects-classic", + "subcategory": "cards", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "archived_state", + "description": "

Filters the project cards that are returned by the card's state.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "archived", + "not_archived" + ], + "default": "not_archived" + } + }, + { + "name": "per_page", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "column_id": "COLUMN_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "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": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/cards/1478" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDExOlByb2plY3RDYXJkMTQ3OA==" + ] + }, + "note": { + "type": [ + "string", + "null" + ], + "examples": [ + "Add payload for delete Project column" + ] + }, + "creator": { "anyOf": [ { "type": "null" @@ -547407,13 +557882,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

The list of reviews returns in chronological order.

" } - ], - "descriptionHTML": "

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
" + ] }, { "serverUrl": "https://api.github.com", @@ -557810,13 +568285,13 @@ } ], "previews": [], + "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a pull request review comment.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a pull request review comment.

" + ] }, { "serverUrl": "https://api.github.com", @@ -565271,13 +575746,13 @@ } ], "previews": [], + "descriptionHTML": "

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

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

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

" + ] } ], "assets": [ @@ -611358,11 +621833,11 @@ }, "before_sha": { "type": "string", - "description": "The first commit sha before the push evaluation." + "description": "The previous commit SHA of the ref." }, "after_sha": { "type": "string", - "description": "The last commit sha in the push evaluation." + "description": "The new commit SHA of the ref." }, "ref": { "type": "string", @@ -674782,13 +685257,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists a team's repositories visible to the authenticated user.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists a team's repositories visible to the authenticated user.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.

\n
" + ] }, { "serverUrl": "https://api.github.com", @@ -686878,13 +697353,13 @@ } ], "previews": [], + "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.

\n
\n

Deletes a comment on a team discussion.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.

\n
\n

Deletes a comment on a team discussion.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" + ] } ], "discussions": [ @@ -694273,13 +704748,13 @@ } ], "previews": [], + "descriptionHTML": "

List IdP groups connected to a team on GitHub Enterprise Cloud.

\n

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

List IdP groups connected to a team on GitHub Enterprise Cloud.

\n

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.

\n
" + ] }, { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index daf609d0d660..6d1249d45069 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -1080,13 +1080,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the GitHub Actions cache usage policy for an enterprise.

\n

OAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the GitHub Actions cache usage policy for an enterprise.

\n

OAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -2014,13 +2014,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -2555,13 +2555,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -2901,13 +2901,13 @@ } ], "previews": [], + "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -3100,13 +3100,13 @@ } ], "previews": [], + "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -4668,13 +4668,13 @@ } ], "previews": [], + "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

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "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

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -5375,13 +5375,13 @@ } ], "previews": [], + "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

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "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

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -6499,13 +6499,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a secret in an organization using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a secret in an organization using the secret name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -9421,13 +9421,13 @@ } ], "previews": [], + "descriptionHTML": "

Creates a new self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Creates a new self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10871,13 +10871,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -11399,13 +11399,13 @@ } ], "previews": [], + "descriptionHTML": "

Updates the name and visibility of a self-hosted runner group in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Updates the name and visibility of a self-hosted runner group in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -19901,13 +19901,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific self-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific self-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -26089,6 +26089,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists all repositories that can access an organization variable\nthat is available to selected repositories.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", @@ -26098,8 +26099,7 @@ "httpStatusCode": "409", "description": "

Response when the visibility of the variable is not set to selected

" } - ], - "descriptionHTML": "

Lists all repositories that can access an organization variable\nthat is available to selected repositories.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -28183,13 +28183,13 @@ } ], "previews": [], + "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.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "302", "description": "

Found

" } - ], - "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.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -29263,13 +29263,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" + ] } ], "workflow-runs": [ @@ -32207,13 +32207,13 @@ } ], "previews": [], + "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.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

\n

This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "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.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

\n

This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -43881,13 +43881,13 @@ } ], "previews": [], + "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

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "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

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] } ] }, @@ -79332,13 +79332,13 @@ } ], "previews": [], + "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
" + ] } ], "feeds": [ @@ -89064,13 +89064,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists repositories a user has starred.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists repositories a user has starred.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
    • \n
" + ] } ], "watching": [ @@ -91795,13 +91795,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -91980,13 +91980,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes the announcement banner currently set for the organization.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Removes the announcement banner currently set for the organization.

" + ] } ] }, @@ -176042,13 +176042,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -188276,13 +188276,13 @@ } ], "previews": [], + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -188897,6 +188897,7 @@ } ], "previews": [], + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -188906,8 +188907,7 @@ "httpStatusCode": "204", "description": "

Response when updating a secret

" } - ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -202046,13 +202046,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -204615,13 +204615,13 @@ } ], "previews": [], + "descriptionHTML": "

This will trigger a ping event to be sent to the webhook.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

This will trigger a ping event to be sent to the webhook.

" + ] } ], "ldap": [ @@ -204748,13 +204748,13 @@ } ], "previews": [], + "descriptionHTML": "

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -205266,13 +205266,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -209956,13 +209956,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -210339,13 +210339,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -210819,13 +210819,13 @@ } ], "previews": [], + "descriptionHTML": "

In addition to seeing the download status at the \"Get a pre-receive environment\" endpoint, there is also this separate endpoint for just the download status.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

In addition to seeing the download status at the \"Get a pre-receive environment\" endpoint, there is also this separate endpoint for just the download status.

" + ] } ], "pre-receive-hooks": [ @@ -211412,13 +211412,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -211917,13 +211917,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -217869,13 +217869,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -238893,6 +238893,7 @@ } ], "previews": [], + "descriptionHTML": "

List all templates available to pass as an option when creating a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -238902,8 +238903,7 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ], - "descriptionHTML": "

List all templates available to pass as an option when creating a repository.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -268799,13 +268799,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes one or more assignees from an issue.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Removes one or more assignees from an issue.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -339387,13 +339387,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:read scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:read scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -344990,13 +344990,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -353589,11 +353589,11 @@ }, "before_sha": { "type": "string", - "description": "The first commit sha before the push evaluation." + "description": "The previous commit SHA of the ref." }, "after_sha": { "type": "string", - "description": "The last commit sha in the push evaluation." + "description": "The new commit SHA of the ref." }, "ref": { "type": "string", @@ -376212,13 +376212,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific package version for a public package owned by a specified user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific package version for a public package owned by a specified user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -431540,13 +431540,13 @@ } ], "previews": [], + "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a pull request review comment.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a pull request review comment.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -482988,11 +482988,11 @@ }, "before_sha": { "type": "string", - "description": "The first commit sha before the push evaluation." + "description": "The previous commit SHA of the ref." }, "after_sha": { "type": "string", - "description": "The last commit sha in the push evaluation." + "description": "The new commit SHA of the ref." }, "ref": { "type": "string", @@ -528531,13 +528531,13 @@ } ], "previews": [], + "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

\n
\n

Creates a new discussion post on a team's page.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion endpoint.

\n
\n

Creates a new discussion post on a team's page.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -529950,13 +529950,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -538450,13 +538450,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the people who the specified user follows.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the people who the specified user follows.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index 59e81284674c..774bb52672a6 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -1468,13 +1468,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -2555,13 +2555,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -2836,13 +2836,13 @@ } ], "previews": [], + "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -4668,13 +4668,13 @@ } ], "previews": [], + "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

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "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

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -4802,13 +4802,13 @@ } ], "previews": [], + "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

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "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

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -5461,13 +5461,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -5543,13 +5543,13 @@ } ], "previews": [], + "descriptionHTML": "

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -8012,13 +8012,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all secrets available in a repository without revealing their encrypted\nvalues.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all secrets available in a repository without revealing their encrypted\nvalues.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -8834,13 +8834,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a single environment secret without revealing its encrypted value.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a single environment secret without revealing its encrypted value.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -9250,13 +9250,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all self-hosted runner groups for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all self-hosted runner groups for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -9563,13 +9563,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10537,13 +10537,13 @@ } ], "previews": [], + "descriptionHTML": "

Replaces the list of self-hosted runners that are part of an enterprise runner group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Replaces the list of self-hosted runners that are part of an enterprise runner group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -16236,13 +16236,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -22430,13 +22430,13 @@ } ], "previews": [], + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -26991,13 +26991,13 @@ } ], "previews": [], + "descriptionHTML": "

Updates a repository variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Updates a repository variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -28144,13 +28144,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific job in a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific job in a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -40360,13 +40360,13 @@ } ], "previews": [], + "descriptionHTML": "

Re-runs your workflow run using its id.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Re-runs your workflow run using its id.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -40453,13 +40453,13 @@ } ], "previews": [], + "descriptionHTML": "

Re-run all of the failed jobs and their dependent jobs in a workflow run using the id of the workflow run.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Re-run all of the failed jobs and their dependent jobs in a workflow run using the id of the workflow run.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -101506,13 +101506,13 @@ } ], "previews": [], + "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -110612,13 +110612,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the GitHub Advanced Security active committers for an organization per repository.

\n

Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.

\n

If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.

\n

The total number of repositories with committer information is tracked by the total_count field.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

Success

" } - ], - "descriptionHTML": "

Gets the GitHub Advanced Security active committers for an organization per repository.

\n

Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.

\n

If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.

\n

The total number of repositories with committer information is tracked by the total_count field.

" + ] } ] }, @@ -129841,6 +129841,7 @@ } ], "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", "statusCodes": [ { "httpStatusCode": "200", @@ -129850,8 +129851,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -131096,13 +131096,13 @@ } ], "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Disables the ability to restrict who can push to this branch.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Disables the ability to restrict who can push to this branch.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -133552,6 +133552,7 @@ } ], "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists the teams who have push access to this branch. The list includes child teams.

", "statusCodes": [ { "httpStatusCode": "200", @@ -133561,8 +133562,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists the teams who have push access to this branch. The list includes child teams.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -143382,13 +143382,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists check runs for a check suite using its id.

\n

Note

\n

\nThe endpoints to manage checks only look 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
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists check runs for a check suite using its id.

\n

Note

\n

\nThe endpoints to manage checks only look 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
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint on a private repository.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -151942,13 +151942,13 @@ } ], "previews": [], + "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.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "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.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -157032,6 +157032,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an owner or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the security_events or repos cope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

", "statusCodes": [ { "httpStatusCode": "200", @@ -157045,8 +157046,7 @@ "httpStatusCode": "503", "description": "

Service unavailable

" } - ], - "descriptionHTML": "

Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an owner or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the security_events or repos cope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -192385,13 +192385,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -195509,13 +195509,13 @@ } ], "previews": [], + "descriptionHTML": "

Simple filtering of deployments is available via query parameters:

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Simple filtering of deployments is available via query parameters:

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -199653,13 +199653,13 @@ } ], "previews": [], + "descriptionHTML": "

Note

\n

\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"

\n
\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Note

\n

\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"Get a deployment branch policy.\"

\n
\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -206332,13 +206332,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -206521,13 +206521,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -206642,13 +206642,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -206710,13 +206710,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -206788,13 +206788,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -207155,13 +207155,13 @@ } ], "previews": [], + "descriptionHTML": "

Sets the message and expiration time for the global announcement banner in your enterprise.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Sets the message and expiration time for the global announcement banner in your enterprise.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -212471,13 +212471,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -213356,13 +213356,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -214814,13 +214814,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -221825,13 +221825,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a personal access token. Returns a 403 - Forbidden status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a personal access token. Returns a 403 - Forbidden status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -233387,6 +233387,7 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", @@ -233404,8 +233405,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -238924,6 +238924,7 @@ } ], "previews": [], + "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", @@ -238933,8 +238934,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Updates a comment on a gist.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.
    • \n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -299173,13 +299173,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a label using the given label name.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -319608,13 +319608,13 @@ } ], "previews": [], + "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -319851,13 +319851,13 @@ } ], "previews": [], + "descriptionHTML": "

Get the octocat as ASCII art

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Get the octocat as ASCII art

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -344817,13 +344817,13 @@ } ], "previews": [], + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.

\n
\n

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

Response - list of custom role names

" } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.

\n
\n

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -346289,13 +346289,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -346381,13 +346381,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

" + ] } ], "members": [ @@ -356975,11 +356975,11 @@ }, "before_sha": { "type": "string", - "description": "The first commit sha before the push evaluation." + "description": "The previous commit SHA of the ref." }, "after_sha": { "type": "string", - "description": "The last commit sha in the push evaluation." + "description": "The new commit SHA of the ref." }, "ref": { "type": "string", @@ -364278,13 +364278,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists teams that are security managers for an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists teams that are security managers for an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -364342,13 +364342,13 @@ } ], "previews": [], + "descriptionHTML": "

Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -364406,13 +364406,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes the security manager role from a team for an organization. For more information, see \"Managing security managers in your organization team from an organization.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Removes the security manager role from a team for an organization. For more information, see \"Managing security managers in your organization team from an organization.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] } ], "webhooks": [ @@ -365544,13 +365544,13 @@ } ], "previews": [], + "descriptionHTML": "

Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use \"Get an organization webhook .\"

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use \"Get an organization webhook .\"

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -381471,13 +381471,13 @@ } ], "previews": [], + "descriptionHTML": "

You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

\n

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

\n

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -412299,13 +412299,13 @@ } ], "previews": [], + "descriptionHTML": "

Edits the content of a specified review comment.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Edits the content of a specified review comment.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -431359,6 +431359,7 @@ } ], "previews": [], + "descriptionHTML": "

List the reactions to a commit comment.

", "statusCodes": [ { "httpStatusCode": "200", @@ -431368,8 +431369,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

List the reactions to a commit comment.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -434254,13 +434254,13 @@ } ], "previews": [], + "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.

\n
\n

Delete a reaction to an issue.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.

\n
\n

Delete a reaction to an issue.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -463066,13 +463066,13 @@ } ], "previews": [], + "descriptionHTML": "

A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.

", "statusCodes": [ { "httpStatusCode": "202", "description": "

Accepted

" } - ], - "descriptionHTML": "

A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -480681,6 +480681,7 @@ } ], "previews": [], + "descriptionHTML": "

Create new or update existing custom property values for a repository.\nUsing a value of null for a custom property will remove or 'unset' the property value from the repository.

\n

Repository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -480698,8 +480699,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Create new or update existing custom property values for a repository.\nUsing a value of null for a custom property will remove or 'unset' the property value from the repository.

\n

Repository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.

" + ] } ], "forks": [ @@ -486569,13 +486569,13 @@ } ], "previews": [], + "descriptionHTML": "

Disables Git LFS for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Disables Git LFS for a repository.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] } ], "rule-suites": [ @@ -486943,11 +486943,11 @@ }, "before_sha": { "type": "string", - "description": "The first commit sha before the push evaluation." + "description": "The previous commit SHA of the ref." }, "after_sha": { "type": "string", - "description": "The last commit sha in the push evaluation." + "description": "The new commit SHA of the ref." }, "ref": { "type": "string", @@ -497083,13 +497083,13 @@ } ], "previews": [], + "descriptionHTML": "

Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"

\n

OAuth app tokens and personal access tokens (classic) need the write:repo_hook or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"

\n

OAuth app tokens and personal access tokens (classic) need the write:repo_hook or repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -519746,13 +519746,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the child teams of the team specified by {team_slug}.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

if child teams exist

" } - ], - "descriptionHTML": "

Lists the child teams of the team specified by {team_slug}.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.

\n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -531197,13 +531197,13 @@ } ], "previews": [], + "descriptionHTML": "

Creates a new discussion post on a team's page.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Creates a new discussion post on a team's page.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index 8a1b49e53afe..9ab875ad4a31 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -2836,13 +2836,13 @@ } ], "previews": [], - "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -2901,13 +2901,13 @@ } ], "previews": [], - "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "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

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -5461,13 +5461,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -5543,13 +5543,13 @@ } ], "previews": [], - "descriptionHTML": "

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -8834,13 +8834,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a single environment secret without revealing its encrypted value.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a single environment secret without revealing its encrypted value.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -9250,13 +9250,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all self-hosted runner groups for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all self-hosted runner groups for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -9563,13 +9563,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10153,13 +10153,13 @@ } ], "previews": [], - "descriptionHTML": "

Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility set to selected. For more information, see \"Create a self-hosted runner group for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10462,13 +10462,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists the self-hosted runners that are in a specific enterprise group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists the self-hosted runners that are in a specific enterprise group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10677,13 +10677,13 @@ } ], "previews": [], - "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -11411,13 +11411,13 @@ } ], "previews": [], - "descriptionHTML": "

Updates the name and visibility of a self-hosted runner group in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Updates the name and visibility of a self-hosted runner group in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -11475,13 +11475,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a self-hosted runner group for an organization.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -13116,13 +13116,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists self-hosted runners that are in a specific organization group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists self-hosted runners that are in a specific organization group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -16060,13 +16060,13 @@ } ], "previews": [], - "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

Example using remove token:

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Returns a token that you can pass to the config script to remove a self-hosted runner from an enterprise. The token expires after one hour.

\n

Example using remove token:

\n

To remove your self-hosted runner from an enterprise, replace TOKEN with the remove token provided by this\nendpoint.

\n
./config.sh remove --token TOKEN\n
\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -16427,7 +16427,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists all labels for a self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -16437,7 +16436,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Lists all labels for a self-hosted runner configured in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -17379,13 +17379,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -18681,13 +18681,13 @@ } ], "previews": [], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -27468,13 +27468,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific variable in an environment.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific variable in an environment.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -55872,13 +55872,13 @@ } ], "previews": [], - "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -67733,13 +67733,13 @@ } ], "previews": [], - "descriptionHTML": "

This is the user's organization dashboard. You must be authenticated as the user to view this.

\n

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

This is the user's organization dashboard. You must be authenticated as the user to view this.

\n

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -82251,13 +82251,13 @@ } ], "previews": [], - "descriptionHTML": "

Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No content

" } - ] + ], + "descriptionHTML": "

Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -109665,7 +109665,6 @@ } ], "previews": [], - "descriptionHTML": "

OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return 404 NOT FOUND.

", "statusCodes": [ { "httpStatusCode": "200", @@ -109675,7 +109674,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return 404 NOT FOUND.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -172341,13 +172341,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -183855,13 +183855,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
    • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
    • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
    • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
    • \n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -196269,13 +196269,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -210095,13 +210095,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -210536,13 +210536,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -210604,13 +210604,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -213022,13 +213022,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the GitHub Advanced Security active committers for an enterprise per repository.

\n

Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.

\n

The total number of repositories with committer information is tracked by the total_count field.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

Success

" } - ] + ], + "descriptionHTML": "

Gets the GitHub Advanced Security active committers for an enterprise per repository.

\n

Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.

\n

The total number of repositories with committer information is tracked by the total_count field.

" } ], "code-security-and-analysis": [ @@ -217795,13 +217795,13 @@ } ], "previews": [], - "descriptionHTML": "

For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

For pre-receive hooks which are allowed to be configured at the org level, you can set enforcement and allow_downstream_configuration

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -247075,7 +247075,6 @@ } ], "previews": [], - "descriptionHTML": "

List all templates available to pass as an option when creating a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -247085,7 +247084,8 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ] + ], + "descriptionHTML": "

List all templates available to pass as an option when creating a repository.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -273868,13 +273868,13 @@ } ], "previews": [], - "descriptionHTML": "

Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -286397,7 +286397,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists events for a repository.

", "statusCodes": [ { "httpStatusCode": "200", @@ -286407,7 +286406,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Lists events for a repository.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -324869,13 +324869,13 @@ } ], "previews": [], - "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -346930,13 +346930,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"

\n

By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"

\n

Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:audit_log scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"

\n

By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"

\n

Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:audit_log scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -351644,13 +351644,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -356239,13 +356239,13 @@ } ], "previews": [], - "descriptionHTML": "

Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Removes an organization role from a team. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -356303,13 +356303,13 @@ } ], "previews": [], - "descriptionHTML": "

Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -356459,13 +356459,13 @@ } ], "previews": [], - "descriptionHTML": "

Remove an organization role from a user. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Remove an organization role from a user. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -362331,11 +362331,11 @@ }, "before_sha": { "type": "string", - "description": "The first commit sha before the push evaluation." + "description": "The previous commit SHA of the ref." }, "after_sha": { "type": "string", - "description": "The last commit sha in the push evaluation." + "description": "The new commit SHA of the ref." }, "ref": { "type": "string", @@ -369706,13 +369706,13 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.

\n
", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.

\n
" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -370790,7 +370790,6 @@ } ], "previews": [], - "descriptionHTML": "

Delete a webhook for an organization.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", "statusCodes": [ { "httpStatusCode": "204", @@ -370800,7 +370799,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Delete a webhook for an organization.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -467060,13 +467060,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -492937,11 +492937,11 @@ }, "before_sha": { "type": "string", - "description": "The first commit sha before the push evaluation." + "description": "The previous commit SHA of the ref." }, "after_sha": { "type": "string", - "description": "The last commit sha in the push evaluation." + "description": "The new commit SHA of the ref." }, "ref": { "type": "string", @@ -535185,13 +535185,13 @@ } ], "previews": [], - "descriptionHTML": "

Get a specific comment on a team discussion.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get a specific comment on a team discussion.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -535647,13 +535647,13 @@ } ], "previews": [], - "descriptionHTML": "

Edits the body text of a discussion comment.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Edits the body text of a discussion comment.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -539113,13 +539113,13 @@ } ], "previews": [], - "descriptionHTML": "

Get a specific discussion on a team's page.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get a specific discussion on a team's page.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -542823,13 +542823,13 @@ } ], "previews": [], - "descriptionHTML": "

Team members will include the members of child teams.

\n

To list members in a team, the team must be visible to the authenticated user.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Team members will include the members of child teams.

\n

To list members in a team, the team must be visible to the authenticated user.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json index 87e7efa52638..9a0d3276890a 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.17-2022-11-28/schema.json @@ -363738,11 +363738,11 @@ }, "before_sha": { "type": "string", - "description": "The first commit sha before the push evaluation." + "description": "The previous commit SHA of the ref." }, "after_sha": { "type": "string", - "description": "The last commit sha in the push evaluation." + "description": "The new commit SHA of the ref." }, "ref": { "type": "string", @@ -494523,11 +494523,11 @@ }, "before_sha": { "type": "string", - "description": "The first commit sha before the push evaluation." + "description": "The previous commit SHA of the ref." }, "after_sha": { "type": "string", - "description": "The last commit sha in the push evaluation." + "description": "The new commit SHA of the ref." }, "ref": { "type": "string", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 203b8aa5b5d4..7433689c4bd3 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -44,5 +44,5 @@ ] } }, - "sha": "f0dc156505ef3ea9ae0fd2f227aca5642c465e4f" + "sha": "e605333115d5123d2ac50baf757e65cbb94a60c3" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 9fa708ae3448..946a7b7844d5 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -120617,13 +120617,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -120901,55 +120901,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -121091,7 +121091,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -121105,19 +121105,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -121257,19 +121257,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -121282,12 +121282,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -121358,13 +121358,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -121642,55 +121642,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -121832,7 +121832,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -121846,19 +121846,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -121998,19 +121998,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -122023,12 +122023,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -122099,13 +122099,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -122383,55 +122383,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -122573,7 +122573,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -122587,19 +122587,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -122739,19 +122739,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -122764,12 +122764,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -122917,13 +122917,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -123201,55 +123201,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -123391,7 +123391,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -123405,19 +123405,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -123557,19 +123557,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -123582,12 +123582,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -123658,13 +123658,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -123942,55 +123942,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -124132,7 +124132,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -124146,19 +124146,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -124298,19 +124298,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -124323,12 +124323,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -124427,23 +124427,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -124595,19 +124595,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -124693,23 +124693,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -124861,19 +124861,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -124933,23 +124933,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -125101,19 +125101,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -125173,23 +125173,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -125341,19 +125341,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -125496,23 +125496,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -125664,19 +125664,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -125762,23 +125762,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -125930,19 +125930,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -126028,23 +126028,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -126196,19 +126196,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -126270,19 +126270,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -126422,19 +126422,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -126447,12 +126447,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -126516,19 +126516,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -126668,19 +126668,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -126693,12 +126693,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -126854,19 +126854,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -127006,19 +127006,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -127031,12 +127031,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 8322be140619..51ca8f7737f7 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -127066,13 +127066,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -127350,55 +127350,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -127540,7 +127540,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -127554,19 +127554,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -127706,19 +127706,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -127731,12 +127731,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -127807,13 +127807,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -128091,55 +128091,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -128281,7 +128281,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -128295,19 +128295,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -128447,19 +128447,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -128472,12 +128472,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -128548,13 +128548,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -128832,55 +128832,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -129022,7 +129022,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -129036,19 +129036,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -129188,19 +129188,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -129213,12 +129213,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -129366,13 +129366,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -129650,55 +129650,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -129840,7 +129840,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -129854,19 +129854,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -130006,19 +130006,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -130031,12 +130031,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -130107,13 +130107,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -130391,55 +130391,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -130581,7 +130581,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -130595,19 +130595,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -130747,19 +130747,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -130772,12 +130772,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -130876,23 +130876,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -131044,19 +131044,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -131142,23 +131142,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -131310,19 +131310,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -131382,23 +131382,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -131550,19 +131550,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -131622,23 +131622,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -131790,19 +131790,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -131945,23 +131945,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -132113,19 +132113,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -132211,23 +132211,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -132379,19 +132379,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -132477,23 +132477,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -132645,19 +132645,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -132719,19 +132719,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -132871,19 +132871,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -132896,12 +132896,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -132965,19 +132965,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -133117,19 +133117,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -133142,12 +133142,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -133303,19 +133303,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -133455,19 +133455,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -133480,12 +133480,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", diff --git a/src/webhooks/data/ghes-3.14/schema.json b/src/webhooks/data/ghes-3.14/schema.json index 24dd7514c94b..e74bc42e9ee2 100644 --- a/src/webhooks/data/ghes-3.14/schema.json +++ b/src/webhooks/data/ghes-3.14/schema.json @@ -96426,13 +96426,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -96710,55 +96710,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -96900,7 +96900,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -96914,19 +96914,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -97066,19 +97066,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -97091,12 +97091,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -97167,13 +97167,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -97451,55 +97451,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -97641,7 +97641,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -97655,19 +97655,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -97807,19 +97807,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -97832,12 +97832,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -97908,13 +97908,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -98192,55 +98192,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -98382,7 +98382,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -98396,19 +98396,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -98548,19 +98548,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -98573,12 +98573,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -98726,13 +98726,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -99010,55 +99010,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -99200,7 +99200,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -99214,19 +99214,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -99366,19 +99366,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -99391,12 +99391,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -99467,13 +99467,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -99751,55 +99751,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -99941,7 +99941,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -99955,19 +99955,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -100107,19 +100107,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -100132,12 +100132,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -100236,23 +100236,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -100404,19 +100404,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -100502,23 +100502,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -100670,19 +100670,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -100742,23 +100742,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -100910,19 +100910,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -100982,23 +100982,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -101150,19 +101150,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -101305,23 +101305,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -101473,19 +101473,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -101571,23 +101571,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -101739,19 +101739,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -101837,23 +101837,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -102005,19 +102005,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] diff --git a/src/webhooks/data/ghes-3.15/schema.json b/src/webhooks/data/ghes-3.15/schema.json index 60f3bc8a336f..aad429a3d1c7 100644 --- a/src/webhooks/data/ghes-3.15/schema.json +++ b/src/webhooks/data/ghes-3.15/schema.json @@ -96609,13 +96609,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -96893,55 +96893,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -97083,7 +97083,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -97097,19 +97097,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -97249,19 +97249,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -97274,12 +97274,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -97350,13 +97350,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -97634,55 +97634,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -97824,7 +97824,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -97838,19 +97838,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -97990,19 +97990,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -98015,12 +98015,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -98091,13 +98091,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -98375,55 +98375,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -98565,7 +98565,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -98579,19 +98579,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -98731,19 +98731,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -98756,12 +98756,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -98909,13 +98909,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -99193,55 +99193,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -99383,7 +99383,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -99397,19 +99397,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -99549,19 +99549,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -99574,12 +99574,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -99650,13 +99650,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -99934,55 +99934,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -100124,7 +100124,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -100138,19 +100138,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -100290,19 +100290,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -100315,12 +100315,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -100419,23 +100419,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -100587,19 +100587,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -100685,23 +100685,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -100853,19 +100853,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -100925,23 +100925,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -101093,19 +101093,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -101165,23 +101165,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -101333,19 +101333,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -101488,23 +101488,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -101656,19 +101656,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -101754,23 +101754,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -101922,19 +101922,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -102020,23 +102020,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -102188,19 +102188,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] diff --git a/src/webhooks/data/ghes-3.16/schema.json b/src/webhooks/data/ghes-3.16/schema.json index c97d72bd3573..ac2bc8a801f2 100644 --- a/src/webhooks/data/ghes-3.16/schema.json +++ b/src/webhooks/data/ghes-3.16/schema.json @@ -98613,13 +98613,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -98897,55 +98897,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -99087,7 +99087,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -99101,19 +99101,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -99253,19 +99253,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -99278,12 +99278,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -99354,13 +99354,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -99638,55 +99638,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -99828,7 +99828,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -99842,19 +99842,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -99994,19 +99994,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -100019,12 +100019,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -100095,13 +100095,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -100379,55 +100379,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -100569,7 +100569,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -100583,19 +100583,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -100735,19 +100735,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -100760,12 +100760,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -100913,13 +100913,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -101197,55 +101197,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -101387,7 +101387,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -101401,19 +101401,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -101553,19 +101553,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -101578,12 +101578,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -101654,13 +101654,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -101938,55 +101938,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -102128,7 +102128,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -102142,19 +102142,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -102294,19 +102294,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -102319,12 +102319,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -102423,23 +102423,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -102591,19 +102591,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -102689,23 +102689,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -102857,19 +102857,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -102929,23 +102929,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -103097,19 +103097,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -103169,23 +103169,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -103337,19 +103337,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -103492,23 +103492,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -103660,19 +103660,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -103758,23 +103758,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -103926,19 +103926,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -104024,23 +104024,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -104192,19 +104192,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] diff --git a/src/webhooks/data/ghes-3.17/schema.json b/src/webhooks/data/ghes-3.17/schema.json index 8f6c4c5125ea..a9e8d2fce899 100644 --- a/src/webhooks/data/ghes-3.17/schema.json +++ b/src/webhooks/data/ghes-3.17/schema.json @@ -101312,13 +101312,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -101596,55 +101596,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -101786,7 +101786,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -101800,19 +101800,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -101952,19 +101952,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -101977,12 +101977,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -102053,13 +102053,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -102337,55 +102337,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -102527,7 +102527,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -102541,19 +102541,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -102693,19 +102693,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -102718,12 +102718,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -102794,13 +102794,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -103078,55 +103078,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -103268,7 +103268,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -103282,19 +103282,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -103434,19 +103434,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -103459,12 +103459,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -103612,13 +103612,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -103896,55 +103896,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -104086,7 +104086,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -104100,19 +104100,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -104252,19 +104252,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -104277,12 +104277,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -104353,13 +104353,13 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the project.

", "isRequired": true }, { @@ -104637,55 +104637,55 @@ { "type": "string", "name": "title", - "description": "", + "description": "

The project title.

", "isRequired": true }, { "type": "string or null", "name": "description", - "description": "", + "description": "

A short description of the project.

", "isRequired": true }, { "type": "boolean", "name": "public", - "description": "", + "description": "

Whether the project is visible to anyone with access to the owner.

", "isRequired": true }, { "type": "string or null", "name": "closed_at", - "description": "", + "description": "

The time when the project was closed.

", "isRequired": true }, { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the project was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the project was last updated.

", "isRequired": true }, { "type": "integer", "name": "number", - "description": "", + "description": "

The project number.

", "isRequired": true }, { "type": "string or null", "name": "short_description", - "description": "", + "description": "

A concise summary of the project.

", "isRequired": true }, { "type": "string or null", "name": "deleted_at", - "description": "", + "description": "

The time when the project was deleted.

", "isRequired": true }, { @@ -104827,7 +104827,7 @@ { "type": "string", "name": "state", - "description": "", + "description": "

The current state of the project.

", "enum": [ "open", "closed" @@ -104841,19 +104841,19 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the status update.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "", + "description": "

The node ID of the status update.

", "isRequired": true }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that this status update belongs to.

" }, { "type": "object", @@ -104993,19 +104993,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the status update was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the status update was last updated.

", "isRequired": true }, { "type": "string or null", "name": "status", - "description": "", + "description": "

The current status.

", "enum": [ "INACTIVE", "ON_TRACK", @@ -105018,12 +105018,12 @@ { "type": "string", "name": "start_date", - "description": "" + "description": "

The start date of the period covered by the update.

" }, { "type": "string", "name": "target_date", - "description": "" + "description": "

The target date associated with the update.

" }, { "type": "string or null", @@ -105122,23 +105122,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -105290,19 +105290,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -105388,23 +105388,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -105556,19 +105556,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -105628,23 +105628,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -105796,19 +105796,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -105868,23 +105868,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -106036,19 +106036,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -106191,23 +106191,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -106359,19 +106359,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -106457,23 +106457,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -106625,19 +106625,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] @@ -106723,23 +106723,23 @@ { "type": "number", "name": "id", - "description": "", + "description": "

The unique identifier of the project item.

", "isRequired": true }, { "type": "string", "name": "node_id", - "description": "" + "description": "

The node ID of the project item.

" }, { "type": "string", "name": "project_node_id", - "description": "" + "description": "

The node ID of the project that contains this item.

" }, { "type": "string", "name": "content_node_id", - "description": "", + "description": "

The node ID of the content represented by this item.

", "isRequired": true }, { @@ -106891,19 +106891,19 @@ { "type": "string", "name": "created_at", - "description": "", + "description": "

The time when the item was created.

", "isRequired": true }, { "type": "string", "name": "updated_at", - "description": "", + "description": "

The time when the item was last updated.

", "isRequired": true }, { "type": "string or null", "name": "archived_at", - "description": "", + "description": "

The time when the item was archived.

", "isRequired": true } ] diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index cadb08b243fa..22ff24999e43 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "f0dc156505ef3ea9ae0fd2f227aca5642c465e4f" + "sha": "e605333115d5123d2ac50baf757e65cbb94a60c3" } \ No newline at end of file