diff --git a/assets/images/help/copilot/coding-agent/agents-page-input.png b/assets/images/help/copilot/coding-agent/agents-page-input.png index 20a495eba573..3a8cb4308310 100644 Binary files a/assets/images/help/copilot/coding-agent/agents-page-input.png and b/assets/images/help/copilot/coding-agent/agents-page-input.png differ diff --git a/assets/images/help/copilot/copilot-usage-tab.png b/assets/images/help/copilot/copilot-usage-tab.png new file mode 100644 index 000000000000..1bce1ea57dfc Binary files /dev/null and b/assets/images/help/copilot/copilot-usage-tab.png differ diff --git a/assets/images/help/copilot/spark-fix-all-errors.png b/assets/images/help/copilot/spark-fix-all-errors.png new file mode 100644 index 000000000000..59a4c05d1276 Binary files /dev/null and b/assets/images/help/copilot/spark-fix-all-errors.png differ diff --git a/assets/images/help/copilot/spark-github-user-visibility.png b/assets/images/help/copilot/spark-github-user-visibility.png new file mode 100644 index 000000000000..030d7778d55e Binary files /dev/null and b/assets/images/help/copilot/spark-github-user-visibility.png differ diff --git a/content/actions/concepts/runners/about-actions-runner-controller.md b/content/actions/concepts/runners/actions-runner-controller.md similarity index 96% rename from content/actions/concepts/runners/about-actions-runner-controller.md rename to content/actions/concepts/runners/actions-runner-controller.md index 621039631040..65c1815050a8 100644 --- a/content/actions/concepts/runners/about-actions-runner-controller.md +++ b/content/actions/concepts/runners/actions-runner-controller.md @@ -1,16 +1,15 @@ --- -title: About Actions Runner Controller -shortTitle: About ARC +title: Actions Runner Controller intro: 'You can host your own runners and customize the environment used to run jobs in your {% data variables.product.prodname_actions %} workflows.' versions: fpt: '*' ghec: '*' ghes: '*' -type: overview topics: - Actions Runner Controller redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller + - /actions/concepts/runners/about-actions-runner-controller --- ## About {% data variables.product.prodname_actions_runner_controller %} @@ -146,18 +145,6 @@ RUN curl -f -L -o runner-container-hooks.zip https://github.com/actions/runner-c USER runner ``` -## Executing workflows - -After installation and configuration are complete, you can use ARC to execute workflow runs. A workflow can be created in the same repository that can target a self hosted runner created by ARC. For more information about targeting workflows to run on self-hosted runners, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow). - -### Using ARC runners in a workflow - -{% data reusables.actions.actions-runner-controller-labels %} For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow). - -## Scaling runners - -You can scale runners statically or dynamically depending on your needs. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller#scaling-runners). - ## Software installed in the ARC runner image The ARC [runner image](https://github.com/actions/runner/pkgs/container/actions-runner) is bundled with the following software: @@ -183,3 +170,11 @@ The supported runner image is released as a separate container image, which you ## Legal notice {% data reusables.actions.actions-runner-controller-legal-notice %} + +## Next steps + +When you're ready to use ARC to execute workflows, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow). + +{% data reusables.actions.actions-runner-controller-labels %} For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow). + +You can scale runners statically or dynamically depending on your needs. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller#scaling-runners). diff --git a/content/actions/concepts/runners/about-github-hosted-runners.md b/content/actions/concepts/runners/github-hosted-runners.md similarity index 98% rename from content/actions/concepts/runners/about-github-hosted-runners.md rename to content/actions/concepts/runners/github-hosted-runners.md index 6fc558423db2..8d42e98c87a6 100644 --- a/content/actions/concepts/runners/about-github-hosted-runners.md +++ b/content/actions/concepts/runners/github-hosted-runners.md @@ -1,6 +1,5 @@ --- -title: About GitHub-hosted runners -shortTitle: GitHub-hosted runners +title: GitHub-hosted runners intro: '{% data variables.product.prodname_dotcom %} offers hosted virtual machines to run workflows. The virtual machine contains an environment of tools, packages, and settings available for {% data variables.product.prodname_actions %} to use.' redirect_from: - /articles/virtual-environments-for-github-actions @@ -14,6 +13,7 @@ redirect_from: - /actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners - /actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners - /actions/how-tos/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners + - /actions/concepts/runners/about-github-hosted-runners versions: fpt: '*' ghes: '*' diff --git a/content/actions/concepts/runners/index.md b/content/actions/concepts/runners/index.md index b3245035aa37..9eac054e5f31 100644 --- a/content/actions/concepts/runners/index.md +++ b/content/actions/concepts/runners/index.md @@ -7,12 +7,12 @@ versions: ghes: '*' ghec: '*' children: - - /about-github-hosted-runners - - /about-larger-runners - - /about-self-hosted-runners - - /about-private-networking-with-github-hosted-runners - - /about-runner-groups - - /about-runner-scale-sets - - /about-actions-runner-controller - - /about-support-for-actions-runner-controller + - /github-hosted-runners + - /larger-runners + - /self-hosted-runners + - /private-networking-with-github-hosted-runners + - /runner-groups + - /runner-scale-sets + - /actions-runner-controller + - /support-for-actions-runner-controller --- diff --git a/content/actions/concepts/runners/about-larger-runners.md b/content/actions/concepts/runners/larger-runners.md similarity index 98% rename from content/actions/concepts/runners/about-larger-runners.md rename to content/actions/concepts/runners/larger-runners.md index 675230d56eeb..80377ea2373c 100644 --- a/content/actions/concepts/runners/about-larger-runners.md +++ b/content/actions/concepts/runners/larger-runners.md @@ -1,6 +1,5 @@ --- -title: About larger runners -shortTitle: Larger runners +title: Larger runners intro: 'Learn about the types and uses of {% data variables.product.prodname_dotcom %}-hosted {% data variables.actions.hosted_runners %}.' permissions: '{% data reusables.actions.larger-runner-permissions %}' versions: @@ -10,6 +9,7 @@ versions: redirect_from: - /actions/using-github-hosted-runners/about-larger-runners/about-larger-runners - /actions/using-github-hosted-runners/using-larger-runners/about-larger-runners + - /actions/concepts/runners/about-larger-runners --- {% ifversion ghes %} diff --git a/content/actions/concepts/runners/about-private-networking-with-github-hosted-runners.md b/content/actions/concepts/runners/private-networking-with-github-hosted-runners.md similarity index 95% rename from content/actions/concepts/runners/about-private-networking-with-github-hosted-runners.md rename to content/actions/concepts/runners/private-networking-with-github-hosted-runners.md index fd6eef9c2f34..1ee4e6cd3cb8 100644 --- a/content/actions/concepts/runners/about-private-networking-with-github-hosted-runners.md +++ b/content/actions/concepts/runners/private-networking-with-github-hosted-runners.md @@ -1,12 +1,11 @@ --- -title: About private networking with GitHub-hosted runners +title: Private networking with GitHub-hosted runners shortTitle: About private networking intro: '{% data reusables.actions.private-networking-intro %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: overview topics: - Actions - Action development @@ -17,6 +16,7 @@ topics: - CD redirect_from: - /actions/using-github-hosted-runners/connecting-to-a-private-network/about-private-networking-with-github-hosted-runners + - /actions/concepts/runners/about-private-networking-with-github-hosted-runners --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/concepts/runners/about-runner-groups.md b/content/actions/concepts/runners/runner-groups.md similarity index 89% rename from content/actions/concepts/runners/about-runner-groups.md rename to content/actions/concepts/runners/runner-groups.md index 4eaa9654fab9..5c943ddfa07e 100644 --- a/content/actions/concepts/runners/about-runner-groups.md +++ b/content/actions/concepts/runners/runner-groups.md @@ -1,12 +1,12 @@ --- -title: About runner groups -shortTitle: Runner groups +title: Runner groups intro: 'Learn about what a runner group is, and how to use them to control access to runners at the organization{% ifversion ghec or ghes %} and/or enterprise levels{% else %} level.{% endif %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: overview +redirect_from: + - /actions/concepts/runners/about-runner-groups --- ## About runner groups diff --git a/content/actions/concepts/runners/about-runner-scale-sets.md b/content/actions/concepts/runners/runner-scale-sets.md similarity index 94% rename from content/actions/concepts/runners/about-runner-scale-sets.md rename to content/actions/concepts/runners/runner-scale-sets.md index bbd45b54cdc2..2417bccdbca3 100644 --- a/content/actions/concepts/runners/about-runner-scale-sets.md +++ b/content/actions/concepts/runners/runner-scale-sets.md @@ -1,15 +1,15 @@ --- -title: About runner scale sets -shortTitle: Runner scale sets +title: Runner scale sets intro: 'Learn about what a runner scale set is and how they can interact with the {% data variables.product.prodname_actions_runner_controller %}.' layout: inline versions: fpt: '*' ghec: '*' ghes: '*' -type: overview topics: - Actions Runner Controller +redirect_from: + - /actions/concepts/runners/about-runner-scale-sets --- ## About runner scale sets diff --git a/content/actions/concepts/runners/about-self-hosted-runners.md b/content/actions/concepts/runners/self-hosted-runners.md similarity index 97% rename from content/actions/concepts/runners/about-self-hosted-runners.md rename to content/actions/concepts/runners/self-hosted-runners.md index 24039acf0057..2a95ad813ec0 100644 --- a/content/actions/concepts/runners/about-self-hosted-runners.md +++ b/content/actions/concepts/runners/self-hosted-runners.md @@ -1,17 +1,16 @@ --- -title: About self-hosted runners -shortTitle: Self-hosted runners +title: Self-hosted runners intro: 'You can host your own runners and customize the environment used to run jobs in your {% data variables.product.prodname_actions %} workflows.' redirect_from: - /github/automating-your-workflow-with-github-actions/about-self-hosted-runners - /actions/automating-your-workflow-with-github-actions/about-self-hosted-runners - /actions/hosting-your-own-runners/about-self-hosted-runners - /actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners + - /actions/concepts/runners/about-self-hosted-runners versions: fpt: '*' ghes: '*' ghec: '*' -type: overview --- A self-hosted runner is a system that you deploy and manage to execute jobs from {% data variables.product.prodname_actions %} on {% data variables.product.github %}. diff --git a/content/actions/concepts/runners/about-support-for-actions-runner-controller.md b/content/actions/concepts/runners/support-for-actions-runner-controller.md similarity index 91% rename from content/actions/concepts/runners/about-support-for-actions-runner-controller.md rename to content/actions/concepts/runners/support-for-actions-runner-controller.md index af28c436d3db..eeabbfccb3e7 100644 --- a/content/actions/concepts/runners/about-support-for-actions-runner-controller.md +++ b/content/actions/concepts/runners/support-for-actions-runner-controller.md @@ -1,7 +1,7 @@ --- -title: About support for Actions Runner Controller +title: Support for Actions Runner Controller +shortTitle: Support for ARC intro: 'What to know before you [contact {% data variables.contact.github_support %}](support/contacting-github-support) for assistance with Actions Runner Controller.' -shortTitle: About Support for ARC versions: fpt: '*' ghec: '*' @@ -11,11 +11,10 @@ topics: - Support redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-support-for-actions-runner-controller + - /actions/concepts/runners/about-support-for-actions-runner-controller --- -You can [contact {% data variables.contact.github_support %}](/support/contacting-github-support) for assistance with Actions Runner Controller. - -## About support for Actions Runner Controller Versions +## Overview The Actions Runner Controller (ARC) project [was adopted by GitHub](https://github.com/actions/actions-runner-controller/discussions/2072) to release as a new GitHub product. As a result, there are currently two ARC releases: the legacy community-maintained ARC and GitHub's Autoscaling Runner Sets. diff --git a/content/actions/concepts/security/artifact-attestations.md b/content/actions/concepts/security/artifact-attestations.md new file mode 100644 index 000000000000..cefa2d1d1378 --- /dev/null +++ b/content/actions/concepts/security/artifact-attestations.md @@ -0,0 +1,55 @@ +--- +title: Artifact attestations +intro: 'Understand the usage and security benefits of artifact attestations.' +shortTitle: Artifact attestations +topics: + - Actions + - Security +versions: + fpt: '*' + ghec: '*' +--- + +## Overview + +{% data reusables.actions.about-artifact-attestations %} + +## SLSA levels for artifact attestations + +The SLSA framework is an industry standard used to evaluate supply chain security. It is organized into levels. Each level represents an increasing degree of security and trustworthiness for a software supply chain. Artifact attestations by itself provides SLSA v1.0 Build Level 2. + +This provides a link between your artifact and its build instructions, but you can take this a step further by requiring builds make use of known, vetted build instructions. A great way to do this is to have your build take place in a reusable workflow that many repositories across your organization share. Reusable workflows can provide isolation between the build process and the calling workflow, to meet SLSA v1.0 Build Level 3. For more information, see [AUTOTITLE](/actions/security-guides/using-artifact-attestations-and-reusable-workflows-to-achieve-slsa-v1-build-level-3). + +For more information on SLSA levels, see [SLSA Security Levels](https://slsa.dev/spec/v1.0/levels). + +## How {% data variables.product.github %} generates artifact attestations + +To generate artifact attestations, {% data variables.product.prodname_dotcom %} uses Sigstore, which is an open source project that offers a comprehensive solution for signing and verifying software artifacts via attestations. + +**Public repositories** that generate artifact attestations use the [Sigstore Public Good Instance](https://openssf.org/blog/2023/10/03/running-sigstore-as-a-managed-service-a-tour-of-sigstores-public-good-instance/). A copy of the generated Sigstore bundle is stored with GitHub and is also written to an immutable transparency log that is publicly readable on the internet. + +**Private repositories** that generate artifact attestations use GitHub's Sigstore instance. GitHub's Sigstore instance uses the same codebase as the Sigstore Public Good Instance, but it does not have a transparency log and only federates with {% data variables.product.prodname_actions %}. + +## When to generate attestations + +Generating attestations alone doesn't provide any security benefit, the attestations must be verified for the benefit to be realized. Here are some guidelines for how to think about what to sign and how often: + +You should sign: + +* Software you are releasing that you expect people to run `gh attestation verify ...` on. +* Binaries people will run, packages people will download, or manifests that include hashes of detailed contents. + +You should **not** sign: + +* Frequent builds that are just for automated testing. +* Individual files like source code, documentation files, or embedded images. + +## Verifying artifact attestations + +If you consume software that publishes artifact attestations, you can use the {% data variables.product.prodname_cli %} to verify those attestations. Because the attestations give you information about where and how software was built, you can use that information to create and enforce security policies that elevate your supply chain security. + +>[!WARNING] It is important to remember that artifact attestations are _not_ a guarantee that an artifact is secure. Instead, artifact attestations link you to the source code and the build instructions that produced them. It is up to you to define your policy criteria, evaluate that policy by evaluating the content, and make an informed risk decision when you are consuming software. + +## Next steps + +To start generating and verifying artifact attestations for your builds, see [AUTOTITLE](/actions/how-tos/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds). diff --git a/content/actions/concepts/security/index.md b/content/actions/concepts/security/index.md index a53815c86dca..7f2f0c723e13 100644 --- a/content/actions/concepts/security/index.md +++ b/content/actions/concepts/security/index.md @@ -10,8 +10,8 @@ children: - /secrets - /github_token - /openid-connect + - /artifact-attestations - /script-injections - /compromised-runners - /kubernetes-admissions-controller --- - diff --git a/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-forks.md b/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-forks.md new file mode 100644 index 000000000000..d2f4b2267391 --- /dev/null +++ b/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-forks.md @@ -0,0 +1,22 @@ +--- +title: Approving workflow runs from forks +intro: 'You can manually approve workflow runs that have been triggered by a contributor''s pull request.' +versions: + fpt: '*' + ghec: '*' + ghes: '*' +shortTitle: Approve workflow runs +redirect_from: + - /actions/managing-workflow-runs/approving-workflow-runs-from-public-forks + - /actions/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-public-forks + - /actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-private-forks + - /actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-public-forks +--- + +Workflow runs triggered by a contributor's pull request from a fork may require manual approval from a maintainer with write access. You can configure workflow approval requirements for a [repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks), [organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#configuring-required-approval-for-workflows-from-public-forks), or [enterprise](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-your-enterprise). + +Workflow runs that have been awaiting approval for more than 30 days are automatically deleted. + +## Approving workflow runs on a pull request from a public fork + +{% data reusables.actions.workflows.approve-workflow-runs %} diff --git a/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-private-forks.md b/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-private-forks.md deleted file mode 100644 index 30ab7eb0b479..000000000000 --- a/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-private-forks.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Approving workflow runs from private forks -intro: 'When someone without write access submits a pull request to a private repository, a maintainer may need to approve any workflow runs.' -permissions: Maintainers with write access to a repository can approve workflow runs. -versions: - fpt: '*' - ghec: '*' - ghes: '*' -shortTitle: Approve private fork runs -redirect_from: - - /actions/managing-workflow-runs/approving-workflow-runs-from-private-forks - - /actions/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-private-forks ---- - -## About workflow runs from private forks - -{% data reusables.actions.private-repository-forks-overview %} For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-private-repositories). - -## Approving workflow runs on a pull request from a private fork - -{% data reusables.actions.workflows.approve-workflow-runs %} diff --git a/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-public-forks.md b/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-public-forks.md deleted file mode 100644 index 909b55c6c26a..000000000000 --- a/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-public-forks.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Approving workflow runs from public forks -intro: 'When an outside contributor submits a pull request to a public repository, a maintainer with write access may need to approve some workflow runs.' -versions: - fpt: '*' - ghec: '*' - ghes: '*' -shortTitle: Approve public fork runs -redirect_from: - - /actions/managing-workflow-runs/approving-workflow-runs-from-public-forks - - /actions/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-public-forks ---- - -## About workflow runs from public forks - -{% data reusables.actions.workflow-run-approve-public-fork %} - -You can configure workflow approval requirements for a [repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks), [organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#configuring-required-approval-for-workflows-from-public-forks), or [enterprise](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-your-enterprise). - -Workflow runs that have been awaiting approval for more than 30 days are automatically deleted. - -## Approving workflow runs on a pull request from a public fork - -{% data reusables.actions.workflows.approve-workflow-runs %} diff --git a/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/index.md b/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/index.md index a0a3e7af5f88..030106d6b318 100644 --- a/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/index.md +++ b/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/index.md @@ -16,8 +16,7 @@ children: - /downloading-workflow-artifacts - /removing-workflow-artifacts - /manage-caches - - /approving-workflow-runs-from-public-forks - - /approving-workflow-runs-from-private-forks + - /approving-workflow-runs-from-forks redirect_from: - /actions/managing-workflow-runs-and-deployments/managing-workflow-runs --- diff --git a/content/actions/how-tos/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-and-reusable-workflows-to-achieve-slsa-v1-build-level-3.md b/content/actions/how-tos/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-and-reusable-workflows-to-achieve-slsa-v1-build-level-3.md index 0efdbb14aab6..060e2b96d79d 100644 --- a/content/actions/how-tos/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-and-reusable-workflows-to-achieve-slsa-v1-build-level-3.md +++ b/content/actions/how-tos/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-and-reusable-workflows-to-achieve-slsa-v1-build-level-3.md @@ -1,8 +1,7 @@ --- title: Using artifact attestations and reusable workflows to achieve SLSA v1 Build Level 3 -shortTitle: Attest with reusable workflows +shortTitle: Increase security rating intro: Building software with reusable workflows and artifact attestations can streamline your supply chain security and help you achieve SLSA v1.0 Build Level 3. -type: quick_start topics: - Actions - Security @@ -15,15 +14,10 @@ redirect_from: - /actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-and-reusable-workflows-to-achieve-slsa-v1-build-level-3 --- -## Introduction - -Artifact attestations are a great way to create unfalsifiable provenance and integrity guarantees for the software you build. - -But remember that by itself, artifact attestations provides links, like the build instructions an artifact was built with, which meets SLSA v1.0 Build Level 2. To make an informed risk decision, it's up to you to follow those links and evaluate those build instructions. - -You can take this a step further by requiring builds make use of known, vetted build instructions. A great way to do this is to have your build take place in a reusable workflow that many repositories across your organization share. Reusable workflows can provide isolation between the build process and the calling workflow, to meet SLSA v1.0 Build Level 3. +## Prerequisites Before starting this guide, you should be familiar with: +* The usage and security benefits of artifact attestations. See [AUTOTITLE](/actions/concepts/security/artifact-attestations). * Generating artifact attestations. See [AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). * Writing and using reusable workflows. See [AUTOTITLE](/actions/using-workflows/reusing-workflows). @@ -33,11 +27,11 @@ First, we need to build with both artifact attestations and a reusable workflow. ### Building with a reusable workflow -If you aren't already using reusable workflows to build your software, you'll need to take your build steps and move them into a reusable workflow. For more information on how to write and call a reusable workflow, see [AUTOTITLE](/actions/using-workflows/reusing-workflows). +If you aren't already using reusable workflows to build your software, you'll need to take your build steps and move them into a reusable workflow. ### Building with artifact attestations -The reusable workflow you use to build your software must also generate artifact attestations to establish build provenance. For more information, see [AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). +The reusable workflow you use to build your software must also generate artifact attestations to establish build provenance. When you use a reusable workflow to generate artifact attestations, both the calling workflow and the reusable workflow need to have the following permissions. @@ -75,7 +69,3 @@ Or if you want to specify the exact workflow: ```bash copy gh attestation verify -o ORGANIZATION_NAME --signer-workflow REUSABLE_ORGANIZATION_NAME/REUSABLE_REPOSITORY_NAME/.github/workflows/reusable.yml PATH/TO/YOUR/BUILD/ARTIFACT-BINARY ``` - -## Conclusion - -You are now building and signing your artifacts in a reusable workflow, which can provide the isolation required by SLSA v1.0 Build Level 3. You can verify artifacts are built with known, vetted build instructions by requiring your artifact was built with a specific workflow, reusable or not. diff --git a/content/actions/how-tos/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds.md b/content/actions/how-tos/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds.md index 0637f4e5b439..0e8d84e01ff0 100644 --- a/content/actions/how-tos/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds.md +++ b/content/actions/how-tos/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds.md @@ -5,51 +5,15 @@ product: '{% data reusables.gated-features.attestations %}' versions: fpt: '*' ghec: '*' -shortTitle: Artifact attestations +shortTitle: Use artifact attestations redirect_from: - /actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds - /actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds --- -## About artifact attestations +## Prerequisites -{% data reusables.actions.about-artifact-attestations %} - -### About SLSA levels for artifact attestations - -The SLSA framework is an industry standard used to evaluate supply chain security. It is organized into levels. Each level represents an increasing degree of security and trustworthiness for a software supply chain. Artifact attestations by itself provides SLSA v1.0 Build Level 2. - -This provides a link between your artifact and its build instructions, but you can take this a step further by requiring builds make use of known, vetted build instructions. A great way to do this is to have your build take place in a reusable workflow that many repositories across your organization share. Reusable workflows can provide isolation between the build process and the calling workflow, to meet SLSA v1.0 Build Level 3. For more information, see [AUTOTITLE](/actions/security-guides/using-artifact-attestations-and-reusable-workflows-to-achieve-slsa-v1-build-level-3). - -For more information on SLSA levels, see [SLSA Security Levels](https://slsa.dev/spec/v1.0/levels). - -### About using Sigstore for artifact attestations - -To generate artifact attestations, {% data variables.product.prodname_dotcom %} uses Sigstore, which is an open source project that offers a comprehensive solution for signing and verifying software artifacts via attestations. - -**Public repositories** that generate artifact attestations use the [Sigstore Public Good Instance](https://openssf.org/blog/2023/10/03/running-sigstore-as-a-managed-service-a-tour-of-sigstores-public-good-instance/). A copy of the generated Sigstore bundle is stored with GitHub and is also written to an immutable transparency log that is publicly readable on the internet. - -**Private repositories** that generate artifact attestations use GitHub's Sigstore instance. GitHub's Sigstore instance uses the same codebase as the Sigstore Public Good Instance, but it does not have a transparency log and only federates with {% data variables.product.prodname_actions %}. - -### What to attest - -Generating attestations alone doesn't provide any security benefit, the attestations must be verified for the benefit to be realized. Here are some guidelines for how to think about what to sign and how often: - -You should sign: - -* Software you are releasing that you expect people to run `gh attestation verify ...` on. -* Binaries people will run, packages people will download, or manifests that include hashes of detailed contents. - -You should **not** sign: - -* Frequent builds that are just for automated testing. -* Individual files like source code, documentation files, or embedded images. - -### About verifying artifact attestations - -If you consume software that publishes artifact attestations, you can use the {% data variables.product.prodname_cli %} to verify those attestations. Because the attestations give you information about where and how software was built, you can use that information to create and enforce security policies that elevate your supply chain security. For more information, see [Verifying artifact attestations with the {% data variables.product.prodname_cli %}](#verifying-artifact-attestations-with-the-github-cli). - ->[!WARNING]It is important to remember that artifact attestations are _not_ a guarantee that an artifact is secure. Instead, artifact attestations link you to the source code and the build instructions that produced them. It is up to you to define your policy criteria, evaluate that policy by evaluating the content, and make an informed risk decision when you are consuming software. +Before you start generating artifact attestations, you need to understand what they are and when you should use them. See [AUTOTITLE](/actions/concepts/security/artifact-attestations). ## Generating artifact attestations for your builds @@ -222,8 +186,6 @@ gh attestation verify PATH/TO/YOUR/BUILD/ARTIFACT-BINARY \ --jq '.[].verificationResult.statement.predicate' ``` -## Managing the lifecycle of attestations - -{% data reusables.actions.lifecycle-of-attestations %} +## Next steps -To find and delete attestations, see [AUTOTITLE](/actions/how-tos/security-for-github-actions/using-artifact-attestations/managing-the-lifecycle-of-artifact-attestations). +To keep your attestations relevant and manageable, you should delete attestations that are no longer needed. See [AUTOTITLE](/actions/how-tos/security-for-github-actions/using-artifact-attestations/managing-the-lifecycle-of-artifact-attestations). diff --git a/content/actions/how-tos/security-for-github-actions/using-artifact-attestations/verifying-attestations-offline.md b/content/actions/how-tos/security-for-github-actions/using-artifact-attestations/verifying-attestations-offline.md index cc5f437f1f5d..09735f729d4c 100644 --- a/content/actions/how-tos/security-for-github-actions/using-artifact-attestations/verifying-attestations-offline.md +++ b/content/actions/how-tos/security-for-github-actions/using-artifact-attestations/verifying-attestations-offline.md @@ -1,8 +1,7 @@ --- title: Verifying attestations offline -shortTitle: Verifying attestations offline +shortTitle: Verify attestations offline intro: Artifact attestations can be verified without an internet connection. -type: quick_start topics: - Actions - Security @@ -15,15 +14,9 @@ redirect_from: - /actions/security-for-github-actions/using-artifact-attestations/verifying-attestations-offline --- -## Introduction +## Prerequisites -Artifact attestations are a great way to create unfalsifiable provenance and integrity guarantees for the software you build. - -By default, attestations are stored in GitHub's attestation API, which `gh attestation verify` will query when you go to verify your attestation. That command will also contact GitHub's servers to check for updated key material to use to verify the attestation. - -This command can work without internet connectivity, but you need to supply the attestation bundle and the key material in the trusted root manually. - -Before starting this guide, you should be building with generating artifact attestations. See [AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). +Before starting this guide, you should be generating artifact attestations for your builds. See [AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). ## Step 1: Download attestation bundle @@ -75,7 +68,3 @@ You can then perform offline verification with the following command: ```bash copy gh attestation verify PATH/TO/YOUR/BUILD/ARTIFACT-BINARY -R ORGANIZATION_NAME/REPOSITORY_NAME --bundle sha256:ae57936def59bc4c75edd3a837d89bcefc6d3a5e31d55a6fa7a71624f92c3c3b.jsonl --custom-trusted-root trusted_root.jsonl ``` - -## Conclusion - -You are now verifying artifact attestations in an offline environment. We recommend importing a new trusted root whenever you are introducing new signed artifacts to your offline environment. diff --git a/content/actions/how-tos/sharing-automations/sharing-actions-and-workflows-with-your-enterprise.md b/content/actions/how-tos/sharing-automations/sharing-actions-and-workflows-with-your-enterprise.md index c8fd9c12322a..df17524edc49 100644 --- a/content/actions/how-tos/sharing-automations/sharing-actions-and-workflows-with-your-enterprise.md +++ b/content/actions/how-tos/sharing-automations/sharing-actions-and-workflows-with-your-enterprise.md @@ -14,7 +14,7 @@ redirect_from: - /actions/sharing-automations/sharing-actions-and-workflows-with-your-enterprise --- -## About {% data variables.product.prodname_actions %} access to internal and private repositories +## Overview If your organization is owned by an enterprise account, you can share actions and reusable workflows within your enterprise, without publishing them publicly, by allowing {% data variables.product.prodname_actions %} workflows to access an internal or private repository that contains the action or reusable workflow. diff --git a/content/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-rate-limits.md b/content/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-rate-limits.md index db4b5df7f106..f0c035616c7d 100644 --- a/content/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-rate-limits.md +++ b/content/admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-rate-limits.md @@ -113,6 +113,6 @@ By default, a maximum of 100 requests is allowed per minute for each IP address. {% data reusables.github-connect.rate-limit-live-dotcom-requests %} > [!IMPORTANT] -> This rate limit will not apply until you also enable the global rate limiter using `ghe-config app.github.rate-limiting-enabled 1`. When you enable the global rate limiter, other {% data variables.product.github %} features may also experience rate limits. Monitor your instance closely to check for any unexpected request rejections. +> This rate limit will not apply until you also enable the global rate limiter directly using `ghe-config app.github.rate-limiting-enabled 1` or indirectly by enabling rate limits for the {% data variables.product.prodname_enterprise_api %}](#enabling-rate-limits-for-the-github-enterprise-server-apis). When you enable the global rate limiter, other {% data variables.product.github %} features may also experience rate limits. Monitor your instance closely to check for any unexpected request rejections. After you make any changes to the values of these settings, run [ghe-config-apply](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-config-apply) to apply the settings. diff --git a/content/copilot/concepts/completions/text-completion.md b/content/copilot/concepts/completions/text-completion.md index 22d2a888516e..629bdce75b81 100644 --- a/content/copilot/concepts/completions/text-completion.md +++ b/content/copilot/concepts/completions/text-completion.md @@ -4,7 +4,7 @@ shortTitle: Text completion allowTitleToDifferFromFilename: true intro: 'Learn about {% data variables.copilot.copilot_autocomplete_pr %}.' versions: - feature: copilot-enterprise + feature: copilot permissions: 'Members of an enterprise with a subscription to [{% data variables.copilot.copilot_enterprise %}](/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise)' topics: - Copilot diff --git a/content/copilot/concepts/copilot-billing/about-billing-for-github-copilot-in-your-enterprise.md b/content/copilot/concepts/copilot-billing/about-billing-for-github-copilot-in-your-enterprise.md index 6229187b4a2d..f417afed043c 100644 --- a/content/copilot/concepts/copilot-billing/about-billing-for-github-copilot-in-your-enterprise.md +++ b/content/copilot/concepts/copilot-billing/about-billing-for-github-copilot-in-your-enterprise.md @@ -49,7 +49,7 @@ A {% data variables.product.prodname_copilot %} seat is a license to use {% data If a single user receives a seat from multiple organizations in the same enterprise, the enterprise will only be billed once per billing cycle for that unique user. One of the organizations that assigned {% data variables.product.prodname_copilot_short %} to the user will be chosen at random each month to be billed for the seat. -Seat assignment is managed by owners of organizations{% ifversion ghec %} that have been granted access to {% data variables.product.prodname_copilot %} at the enterprise level{% endif %}. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization). +Seat assignment is managed by owners of organizations that have been granted access to {% data variables.product.prodname_copilot %} at the enterprise level. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization). If you are a member of an organization or enterprise with a {% data variables.product.prodname_copilot %} plan, to use the plan, you will need to be assigned a seat by an organization owner. diff --git a/content/copilot/concepts/copilot-billing/about-billing-for-github-spark.md b/content/copilot/concepts/copilot-billing/about-billing-for-github-spark.md new file mode 100644 index 000000000000..be3d4dad3ff9 --- /dev/null +++ b/content/copilot/concepts/copilot-billing/about-billing-for-github-spark.md @@ -0,0 +1,34 @@ +--- +title: About billing for GitHub Spark +intro: 'Learn how {% data variables.product.prodname_spark %} is billed for users.' +versions: + feature: spark +topics: + - Copilot +shortTitle: Billing for Spark +--- + +{% data reusables.copilot.spark-business-intro %} + +> [!NOTE] +> {% data reusables.spark.preview-note-spark %} + +## Billing for {% data variables.product.prodname_spark_short %} app creation + +Each prompt consumes 4 premium requests, which draw from your plan's premium request allowance. If you or an administrator has set a budget for premium requests over your plan's allowance, additional premium requests beyond your plan’s included amount are billed at {% data variables.copilot.additional_premium_requests %} per request, meaning that one prompt to {% data variables.product.prodname_spark_short %} would cost **$0.16**. See [AUTOTITLE](/copilot/concepts/copilot-billing/understanding-and-managing-requests-in-copilot). + +## Billing and limits for {% data variables.product.prodname_spark_short %} app deployment + +You can publish apps created with {% data variables.product.prodname_spark_short %} to a deployment environment. + +Deployed apps do not currently incur any charges. However, {% data variables.product.company_short %} currently **limits usage** of deployed sparks based on criteria including number of HTTP requests, data transfer, and storage. + +* Limits apply to the billable owner, meaning if you own 10 deployed sparks, all 10 will count towards the limits. +* When any limit is reached, the spark is unpublished for the rest of the billing period. + +In the future, a new billing system will allow sparks to continue being deployed once a limit is reached, with additional usage charged to the spark's billable owner. {% data variables.product.company_short %} will publish the limits once they are confirmed following a testing period. This article will be updated when more details are available. + +## Further reading + +* [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-spark) +* [AUTOTITLE](/copilot/tutorials/building-ai-app-prototypes) diff --git a/content/copilot/concepts/copilot-billing/about-billing-for-individual-copilot-plans.md b/content/copilot/concepts/copilot-billing/about-billing-for-individual-copilot-plans.md index d55596017e29..5b2ba11e0389 100644 --- a/content/copilot/concepts/copilot-billing/about-billing-for-individual-copilot-plans.md +++ b/content/copilot/concepts/copilot-billing/about-billing-for-individual-copilot-plans.md @@ -52,6 +52,8 @@ You can cancel your {% data variables.product.prodname_copilot_short %} trial at Your {% data variables.product.prodname_copilot_short %} plan includes premium requests. Premium requests use more advanced models or features and count against your monthly premium request allowance. +The premium request quota renews on the first day of the month, regardless of the subscription renewal date. + To learn more about premium requests and how they affect your billing, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/monitoring-usage-and-entitlements/avoiding-unexpected-copilot-costs). ### Purchasing additional premium requests diff --git a/content/copilot/concepts/copilot-billing/index.md b/content/copilot/concepts/copilot-billing/index.md index 546a7f0090b0..aeb1cb5e7231 100644 --- a/content/copilot/concepts/copilot-billing/index.md +++ b/content/copilot/concepts/copilot-billing/index.md @@ -12,6 +12,7 @@ children: - /about-billing-for-individual-copilot-plans - /about-billing-for-github-copilot-in-your-organization - /about-billing-for-github-copilot-in-your-enterprise + - /about-billing-for-github-spark redirect_from: - /managing-copilot/managing-copilot-as-an-individual-subscriber/billing-and-payments - /copilot/managing-copilot/understanding-and-managing-copilot-usage diff --git a/content/copilot/concepts/copilot-billing/understanding-and-managing-requests-in-copilot.md b/content/copilot/concepts/copilot-billing/understanding-and-managing-requests-in-copilot.md index 676355ed8e46..d74b3abf097a 100644 --- a/content/copilot/concepts/copilot-billing/understanding-and-managing-requests-in-copilot.md +++ b/content/copilot/concepts/copilot-billing/understanding-and-managing-requests-in-copilot.md @@ -39,6 +39,7 @@ The following {% data variables.product.prodname_copilot_short %} features can u | [{% data variables.product.prodname_copilot_short %} code review](/copilot/using-github-copilot/code-review/using-copilot-code-review) | When you assign {% data variables.product.prodname_copilot_short %} as a reviewer for a pull request, **one premium request** is used each time {% data variables.product.prodname_copilot_short %} posts comments to the pull request. | | [{% data variables.copilot.copilot_extensions_short %}](/copilot/building-copilot-extensions/about-building-copilot-extensions) | {% data variables.copilot.copilot_extensions_short %} uses **one premium request** per user prompt, multiplied by the model's rate. | | [{% data variables.copilot.copilot_spaces %}](/copilot/using-github-copilot/copilot-spaces/about-organizing-and-sharing-context-with-copilot-spaces) | {% data variables.copilot.copilot_spaces %} uses **one premium request** per user prompt, multiplied by the model's rate. | +| [{% data variables.product.prodname_spark_short %}](/copilot/tutorials/building-ai-app-prototypes) | Each prompt to {% data variables.product.prodname_spark_short %} uses a fixed rate of **four premium requests**. | ## How do request allowances work per plan? diff --git a/content/copilot/get-started/github-copilot-features.md b/content/copilot/get-started/github-copilot-features.md index 49df6f2778ba..ad2826380a67 100644 --- a/content/copilot/get-started/github-copilot-features.md +++ b/content/copilot/get-started/github-copilot-features.md @@ -69,6 +69,10 @@ Organize and centralize relevant content—like code, docs, specs, and more—in Create and manage collections of documentation to use as context for chatting with {% data variables.product.prodname_copilot_short %}. When you ask a question in {% data variables.copilot.copilot_chat_dotcom_short %} or in {% data variables.product.prodname_vscode_shortname %}, you can specify a knowledge base as the context for your question. See [AUTOTITLE](/copilot/customizing-copilot/managing-copilot-knowledge-bases). +### {% data variables.product.prodname_spark %} ({% data variables.release-phases.public_preview %}) + +Build and deploy full-stack applications using natural-language prompts that seamlessly integrate with the {% data variables.product.github %} platform for advanced development. See [AUTOTITLE](/copilot/tutorials/building-ai-app-prototypes). + ## {% data variables.product.prodname_copilot %} features for administrators The following features are available to organization and enterprise owners with a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan. diff --git a/content/copilot/how-tos/administer/enterprises/index.md b/content/copilot/how-tos/administer/enterprises/index.md index 097510b071c2..7e4952eb3745 100644 --- a/content/copilot/how-tos/administer/enterprises/index.md +++ b/content/copilot/how-tos/administer/enterprises/index.md @@ -3,7 +3,7 @@ title: Managing GitHub Copilot in your enterprise shortTitle: Manage for enterprise intro: 'Enterprise owners can subscribe to {% data variables.product.prodname_copilot_short %}, manage {% data variables.product.prodname_copilot_short %} for organizations in the enterprise, and control {% data variables.product.prodname_copilot_short %} policies.' versions: - feature: copilot-enterprise + feature: copilot topics: - Copilot children: diff --git a/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md index 2f52703d73a4..8f892cb5a247 100644 --- a/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md @@ -5,7 +5,7 @@ intro: 'Disable {% data variables.product.prodname_copilot %} for some or all of permissions: Enterprise owners product: 'Enterprises with a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} plan' versions: - feature: copilot-enterprise + feature: copilot topics: - Copilot redirect_from: diff --git a/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md index a155fb855a96..d981fb6c61e5 100644 --- a/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md @@ -5,7 +5,7 @@ intro: 'Enable {% data variables.product.prodname_copilot %} for some or all of permissions: Enterprise owners product: 'Enterprises with a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} plan' versions: - feature: copilot-enterprise + feature: copilot topics: - Copilot redirect_from: diff --git a/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/index.md b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/index.md index 3b5bdeee7cc2..96b3312e945a 100644 --- a/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/index.md +++ b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/index.md @@ -3,7 +3,7 @@ title: Managing access to Copilot in your enterprise shortTitle: Manage access intro: 'Enterprise owners can manage {% data variables.product.prodname_copilot_short %} for organizations in the enterprise.' versions: - feature: copilot-enterprise + feature: copilot topics: - Copilot children: diff --git a/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/managing-github-copilot-access-to-your-enterprises-network.md b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/managing-github-copilot-access-to-your-enterprises-network.md index 4017603e9b6a..6928dd84cd3d 100644 --- a/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/managing-github-copilot-access-to-your-enterprises-network.md +++ b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/managing-github-copilot-access-to-your-enterprises-network.md @@ -4,7 +4,7 @@ intro: 'Learn how to use subscription-based network routing to control {% data v permissions: Enterprise owners product: '{% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %}' versions: - feature: copilot-enterprise + feature: copilot topics: - Copilot shortTitle: Manage network access diff --git a/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/viewing-copilot-license-usage-in-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/viewing-copilot-license-usage-in-your-enterprise.md index a8b9b873f77e..180576f7f69d 100644 --- a/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/viewing-copilot-license-usage-in-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/viewing-copilot-license-usage-in-your-enterprise.md @@ -1,11 +1,11 @@ --- title: Viewing Copilot license usage in your enterprise shortTitle: View license usage -intro: 'View how many users have access to {% data variables.product.prodname_copilot %} across {% ifversion fpt %}your organization{% else %} all the organizations in your enterprise{% endif %}.' +intro: 'View how many users have access to {% data variables.product.prodname_copilot %} across your enterprise.' product: 'Enterprises with a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} plan' permissions: Enterprise owners versions: - feature: copilot-enterprise + feature: copilot type: how_to topics: - Copilot @@ -16,45 +16,10 @@ redirect_from: - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/viewing-copilot-license-usage-in-your-enterprise --- -## About your {% data variables.product.prodname_copilot %} usage - -If you have a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan, you can view usage information for {% data variables.product.prodname_copilot_short %} in your {% ifversion ghec %}enterprise, broken down by organization, or in your{% endif %} organization, broken down by seat assignment status. {% ifversion ghec %}At the enterprise level, this information includes the number of seats assigned in each organization, and the total spending associated with each organization, for the current billing cycle.{% endif %} At the organization level, this information includes the total number of seats, seats carried over from the previous billing cycle, new seats added during the current cycle, and seats to be removed at the end of the current cycle. - -{% ifversion ghec %} - -## Viewing {% data variables.product.prodname_copilot_short %} license usage at the enterprise-level +If you have a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan, you can view usage information for {% data variables.product.prodname_copilot_short %} in your enterprise. This information includes the number of seats assigned and the total spending for the current billing cycle. {% data reusables.enterprise-accounts.access-enterprise %} -{% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.billing-tab %} -1. Under "{% data variables.product.prodname_copilot_short %} monthly usage," view the breakdown of your {% data variables.product.prodname_copilot %} usage. - - ![Screenshot of enterprise-level billing, showing the section headed '{% data variables.product.prodname_copilot_short %} monthly usage.'](/assets/images/help/copilot/enterprise-level-seat-view.png) - - The figures represent the billed seats so far for the current billing cycle. The seat usage so far this month is calculated as the number of seats, divided by the number of days in the current billing cycle, multiplied by the days elapsed so far in the billing cycle. So, if you have 5 seats assigned from the beginning of the billing cycle, and the current cycle is 30 days long, and it's the 10th day of the cycle, this figure will be 1.6666. On day 20, it will be 3.3333 and on the last day of the cycle, it will be 5. - - The total spending for each organization for the current cycle will usually be the number of seats assigned, multiplied by the cost per seat. For more information, see [AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot-business-and-github-copilot-enterprise). However, if the same organization member is assigned a seat in multiple organizations, their seat usage will be included for each organization, but the enterprise will only be charged once. The cost for this person will only be included in the organization where they were first assigned a seat. - -1. Optionally, to receive a CSV report by email detailing the usage of {% data variables.product.prodname_actions %}, {% data variables.product.prodname_registry %}, {% data variables.product.prodname_github_codespaces %}, and {% data variables.product.prodname_copilot %} for each of your enterprise account's organizations, under the billing summary at the top of the page click **Get usage report**. The report is sent to your account's primary email address. - - ![Screenshot of the header of the billing settings page on GitHub. A button, labeled "Get usage report", is highlighted with an orange outline.](/assets/images/help/billing/actions-packages-report-download-enterprise.png) - -## Viewing {% data variables.product.prodname_copilot_short %} license usage at the organization-level - -{% else %} - -## Viewing your organization's use of {% data variables.product.prodname_copilot %} - -{% endif %} - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -1. In the "Access" section of the sidebar, click **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing and plans**. -1. Under "{% data variables.product.prodname_copilot_short %}", view the breakdown of your {% data variables.product.prodname_copilot %} usage and upcoming changes in your organization. - - ![Screenshot of the organization-level {% data variables.product.prodname_copilot %} seat usage page.](/assets/images/help/copilot/org-level-seat-view.png) - - The figure for Total Seats shows how many seats are currently assigned for {% data variables.product.prodname_copilot %}. +1. Scroll to the bottom of the page and click the **Copilot** tab. -1. Optionally, to download a CSV report detailing the usage of {% data variables.product.prodname_actions %}, {% data variables.product.prodname_registry %}, {% data variables.product.prodname_github_codespaces %}, and {% data variables.product.prodname_copilot %} in your organization, next to "Usage this month", click **Get usage report**. An email containing a link for downloading the CSV report is sent to the primary email address for your account. You can choose whether the report should cover the last 7, 30, 90, or 180 days. - ![Screenshot of the "Billing and plans" settings. A button, labeled "Get usage report", is highlighted with an orange outline.](/assets/images/help/billing/actions-packages-report-download.png) + ![Screenshot of the Copilot usage tab in the enterprise billing settings.](/assets/images/help/copilot/copilot-usage-tab.png) diff --git a/content/copilot/how-tos/administer/enterprises/managing-copilot-coding-agent-in-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-copilot-coding-agent-in-your-enterprise.md index 27524eb1b8fc..fdb272b35e07 100644 --- a/content/copilot/how-tos/administer/enterprises/managing-copilot-coding-agent-in-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-copilot-coding-agent-in-your-enterprise.md @@ -5,7 +5,7 @@ allowTitleToDifferFromFilename: true permissions: Enterprise owners product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: - feature: copilot-enterprise + feature: copilot topics: - Copilot shortTitle: 'Manage {% data variables.copilot.copilot_coding_agent %}' diff --git a/content/copilot/how-tos/administer/enterprises/managing-policies-and-features-for-copilot-in-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-policies-and-features-for-copilot-in-your-enterprise.md index e9c54a86818f..2ea3b4f2c7ad 100644 --- a/content/copilot/how-tos/administer/enterprises/managing-policies-and-features-for-copilot-in-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-policies-and-features-for-copilot-in-your-enterprise.md @@ -4,7 +4,7 @@ intro: 'Control the availability of features for {% data variables.product.prodn permissions: Enterprise owners product: '{% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %}' versions: - feature: copilot-enterprise + feature: copilot allowTitleToDifferFromFilename: true type: how_to topics: diff --git a/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/canceling-copilot-for-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/canceling-copilot-for-your-enterprise.md index f7e70a3683ad..911ea988b1a9 100644 --- a/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/canceling-copilot-for-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/canceling-copilot-for-your-enterprise.md @@ -5,7 +5,7 @@ intro: 'Disabling {% data variables.product.prodname_copilot %} for all organiza permissions: Enterprise admins product: '{% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %}' versions: - feature: copilot-enterprise + feature: copilot topics: - Copilot redirect_from: diff --git a/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/downgrading-copilot-for-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/downgrading-copilot-for-your-enterprise.md index 174b42dce64e..a197fdb29f65 100644 --- a/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/downgrading-copilot-for-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/downgrading-copilot-for-your-enterprise.md @@ -5,7 +5,7 @@ intro: 'You can downgrade organizations in your enterprise from {% data variable permissions: Enterprise owners product: 'Enterprises with a {% data variables.copilot.copilot_enterprise_short %} plan' versions: - feature: copilot-enterprise + feature: copilot topics: - Copilot redirect_from: diff --git a/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/index.md b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/index.md index 2e708f4b2000..a878c98ff76f 100644 --- a/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/index.md +++ b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/index.md @@ -3,7 +3,7 @@ title: Managing the Copilot plan for your enterprise shortTitle: Manage plan intro: 'Enterprise owners can manage the {% data variables.product.prodname_copilot_short %} plan for the enterprise.' versions: - feature: copilot-enterprise + feature: copilot topics: - Copilot children: diff --git a/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md index 22bfd67a9736..5330c5abd26d 100644 --- a/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md @@ -5,7 +5,7 @@ intro: 'Enterprise owners can set up a {% data variables.copilot.copilot_enterpr permissions: Enterprise owners product: 'Enterprises on {% data variables.product.prodname_ghe_cloud %}' versions: - feature: copilot-enterprise + feature: copilot topics: - Copilot redirect_from: diff --git a/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/upgrading-copilot-for-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/upgrading-copilot-for-your-enterprise.md index e5414a11be6d..84b7984a6d3e 100644 --- a/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/upgrading-copilot-for-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/upgrading-copilot-for-your-enterprise.md @@ -5,7 +5,7 @@ intro: 'Change your enterprise''s plan from {% data variables.copilot.copilot_bu permissions: Enterprise owners product: 'Enterprises with a {% data variables.copilot.copilot_business_short %} plan' versions: - feature: copilot-enterprise + feature: copilot topics: - Copilot redirect_from: diff --git a/content/copilot/how-tos/administer/index.md b/content/copilot/how-tos/administer/index.md index dfdba0967b58..cbdaa63e9c80 100644 --- a/content/copilot/how-tos/administer/index.md +++ b/content/copilot/how-tos/administer/index.md @@ -1,6 +1,6 @@ --- title: Administer GitHub Copilot for your team -shortTitle: Administer +shortTitle: Administer Copilot intro: 'Learn how to administer {% data variables.product.prodname_copilot %} for your organization or enterprise.' versions: feature: copilot @@ -11,4 +11,3 @@ children: - /enterprises - /download-activity-report --- - diff --git a/content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business.md b/content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business.md index 1751f217aee9..d3ef1463c448 100644 --- a/content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business.md +++ b/content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business.md @@ -1,6 +1,6 @@ --- title: Reviewing audit logs for Copilot Business -shortTitle: Audit logs +shortTitle: Review audit logs intro: 'Review the audit logs for your {% data variables.copilot.copilot_business_short %} plan to understand what actions have been taken by which users.' redirect_from: - /copilot/managing-copilot-for-business/reviewing-your-organization-or-enterprises-audit-logs-for-copilot-for-business diff --git a/content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization.md b/content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization.md index ed0338bfc3c4..54f3bfc559db 100644 --- a/content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization.md +++ b/content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization.md @@ -1,6 +1,6 @@ --- title: Reviewing user activity data for Copilot in your organization -shortTitle: User activity data +shortTitle: Review user activity data intro: 'Review {% data variables.product.prodname_copilot %} usage in your organization to make informed decisions about seat assignment.' permissions: Organization owners product: 'Organizations with a plan to {% ifversion ghec %}{% data variables.copilot.copilot_enterprise_short %} or{% endif %} {% data variables.copilot.copilot_business_short %}' diff --git a/content/copilot/how-tos/agents/copilot-code-review/configuring-automatic-code-review-by-copilot.md b/content/copilot/how-tos/agents/copilot-code-review/configuring-automatic-code-review-by-copilot.md index 32d26657e103..988d7c871ca3 100644 --- a/content/copilot/how-tos/agents/copilot-code-review/configuring-automatic-code-review-by-copilot.md +++ b/content/copilot/how-tos/agents/copilot-code-review/configuring-automatic-code-review-by-copilot.md @@ -1,6 +1,6 @@ --- title: Configuring automatic code review by Copilot -shortTitle: Automatic code review +shortTitle: Configure automatic review intro: 'Learn how to configure {% data variables.product.prodname_copilot_short %} to automatically review pull requests.' versions: feature: copilot diff --git a/content/copilot/how-tos/agents/copilot-code-review/index.md b/content/copilot/how-tos/agents/copilot-code-review/index.md index b422407a02d8..d29f680c7bc7 100644 --- a/content/copilot/how-tos/agents/copilot-code-review/index.md +++ b/content/copilot/how-tos/agents/copilot-code-review/index.md @@ -1,6 +1,6 @@ --- title: Code review -shortTitle: Code review +shortTitle: Request a code review intro: 'Learn how to request a code review from {% data variables.product.prodname_copilot %}.' versions: feature: copilot @@ -13,4 +13,3 @@ children: redirect_from: - /copilot/using-github-copilot/code-review --- - diff --git a/content/copilot/how-tos/agents/copilot-coding-agent/asking-copilot-to-create-a-pull-request.md b/content/copilot/how-tos/agents/copilot-coding-agent/asking-copilot-to-create-a-pull-request.md index 86640f4e92eb..88c97f2f0b77 100644 --- a/content/copilot/how-tos/agents/copilot-coding-agent/asking-copilot-to-create-a-pull-request.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/asking-copilot-to-create-a-pull-request.md @@ -35,12 +35,15 @@ You can ask {% data variables.product.prodname_copilot_short %} to work on a tas You can also reach this page by clicking the **{% octicon "copilot" aria-label="Copilot icon" %}** button next to the search bar on any page on {% data variables.product.github %}, then selecting **Agents** from the sidebar. 1. Using the dropdown menu in the prompt field, select the repository you want {% data variables.product.prodname_copilot_short %} to work in. + 1. Type a prompt describing your request. For example, `Implement a user friendly message for common errors.` ![Screenshot of asking Copilot to create a pull request from the Agents page.](/assets/images/help/copilot/coding-agent/agents-page-input.png) +1. Optionally, select a base branch for {% data variables.product.prodname_copilot_short %}'s pull request. {% data variables.product.prodname_copilot_short %} will create a new branch based on this branch, then push its changes to a pull request targeting that branch. + 1. Click the **Send now** button or press Return. {% data variables.product.prodname_copilot_short %} will start a new session, which will appear in the list below the prompt box. {% data variables.product.prodname_copilot_short %} will work on the task and push changes to its pull request, then add you as a reviewer when it has finished, triggering a notification. diff --git a/content/copilot/how-tos/agents/copilot-coding-agent/best-practices-for-using-copilot-to-work-on-tasks.md b/content/copilot/how-tos/agents/copilot-coding-agent/best-practices-for-using-copilot-to-work-on-tasks.md index ffa01840dc43..db8f161f34a3 100644 --- a/content/copilot/how-tos/agents/copilot-coding-agent/best-practices-for-using-copilot-to-work-on-tasks.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/best-practices-for-using-copilot-to-work-on-tasks.md @@ -1,6 +1,6 @@ --- title: Best practices for using Copilot to work on tasks -shortTitle: Best practices +shortTitle: Get the best results intro: 'Learn how to get the best results from {% data variables.copilot.copilot_coding_agent %}.' product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: @@ -70,7 +70,7 @@ By adding custom instructions to your repository, you can guide {% data variable If {% data variables.product.prodname_copilot_short %} is able to build, test and validate its changes in its own development environment, it is more likely to produce good pull requests which can be merged quickly. -Add instructions to a `.github/copilot-instructions.md` file in the repository. For more information, see [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot?tool=webui). +You can add instructions in a single `.github/copilot-instructions.md` file in the repository, or create one or more `.github/instructions/**/*.instructions.md` files applying to different files or directories in your repository. For more information, see [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot?tool=webui). Here is an example of an effective `copilot-instructions.md` file: @@ -107,7 +107,7 @@ This is a Go based repository with a Ruby client for certain API endpoints. It i 5. Document public APIs and complex logic. Suggest changes to the `docs/` folder when appropriate ``` -If you choose not to include a `.github/copilot-instructions.md` file in your repository, {% data variables.product.prodname_copilot_short %} will fall back to pre-existing custom instructions including `CLAUDE.md`, `AGENTS.md` and `GEMINI.md`. +If you choose not to include any {% data variables.product.prodname_copilot_short %} instructions files in your repository, {% data variables.product.prodname_copilot_short %} will fall back to pre-existing custom instructions including `CLAUDE.md`, `AGENTS.md` and `GEMINI.md`. ## Using the Model Context Protocol (MCP) diff --git a/content/copilot/how-tos/agents/copilot-coding-agent/enabling-copilot-coding-agent.md b/content/copilot/how-tos/agents/copilot-coding-agent/enabling-copilot-coding-agent.md index 730350f4fd95..788697666815 100644 --- a/content/copilot/how-tos/agents/copilot-coding-agent/enabling-copilot-coding-agent.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/enabling-copilot-coding-agent.md @@ -1,5 +1,6 @@ --- title: Enabling Copilot coding agent +shortTitle: Enable coding agent intro: 'You can allow {% data variables.product.prodname_copilot_short %} to work on code and raise pull requests.' product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: diff --git a/content/copilot/how-tos/agents/copilot-coding-agent/index.md b/content/copilot/how-tos/agents/copilot-coding-agent/index.md index a517abb2fa71..c635fa71bfd7 100644 --- a/content/copilot/how-tos/agents/copilot-coding-agent/index.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/index.md @@ -1,5 +1,6 @@ --- title: Coding agent +shortTitle: Use coding agent intro: 'Find out how {% data variables.product.prodname_copilot_short %} can work on {% data variables.product.github %} issues and raise pull requests for your to review.' versions: feature: copilot diff --git a/content/copilot/how-tos/agents/copilot-coding-agent/tracking-copilots-sessions.md b/content/copilot/how-tos/agents/copilot-coding-agent/tracking-copilots-sessions.md index 925e443f5806..282c68f1e1ab 100644 --- a/content/copilot/how-tos/agents/copilot-coding-agent/tracking-copilots-sessions.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/tracking-copilots-sessions.md @@ -35,8 +35,6 @@ You can see a list of your running and past agent sessions on the Agents page at You can also reach this page by clicking the **{% octicon "copilot" aria-label="Copilot icon" %}** button next to the search bar on any page on {% data variables.product.github %}, then selecting **Agents** from the sidebar. -![Screenshot of the Agents page with several sessions, including one currently in progress.](/assets/images/help/copilot/coding-agent/agents-page.png) - For each session listed below the prompt field, you can see its status at a glance, or click on it to navigate to the linked pull request. To view the session logs, click through to the pull request in the list, then find the "{% data variables.product.prodname_copilot_short %} started work..." event in the timeline, and then click **View session**. diff --git a/content/copilot/how-tos/agents/copilot-coding-agent/troubleshooting-copilot-coding-agent.md b/content/copilot/how-tos/agents/copilot-coding-agent/troubleshooting-copilot-coding-agent.md index 30f48c5ea1c4..c9ba6b54d17e 100644 --- a/content/copilot/how-tos/agents/copilot-coding-agent/troubleshooting-copilot-coding-agent.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/troubleshooting-copilot-coding-agent.md @@ -1,6 +1,6 @@ --- title: Troubleshooting Copilot coding agent -shortTitle: Troubleshooting +shortTitle: Troubleshoot coding agent intro: 'Learn how to resolve problems that may occur when you assign tasks to {% data variables.product.prodname_copilot_short %}.' product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: diff --git a/content/copilot/how-tos/agents/copilot-coding-agent/using-copilot-to-work-on-an-issue.md b/content/copilot/how-tos/agents/copilot-coding-agent/using-copilot-to-work-on-an-issue.md index 27fb542bdc01..d082f5a23826 100644 --- a/content/copilot/how-tos/agents/copilot-coding-agent/using-copilot-to-work-on-an-issue.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/using-copilot-to-work-on-an-issue.md @@ -1,5 +1,6 @@ --- title: Using Copilot to work on an issue +shortTitle: Assign Copilot to an issue intro: 'Learn how to assign issues to {% data variables.product.prodname_copilot %}, monitor progress as {% data variables.product.prodname_copilot_short %} works on the issue, and then use pull request review comments to prompt {% data variables.product.prodname_copilot_short %} to iterate on its work.' product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: diff --git a/content/copilot/how-tos/agents/index.md b/content/copilot/how-tos/agents/index.md index d0e622d50565..cd07ef33d884 100644 --- a/content/copilot/how-tos/agents/index.md +++ b/content/copilot/how-tos/agents/index.md @@ -1,6 +1,6 @@ --- title: Use GitHub Copilot agents -shortTitle: Agents +shortTitle: Use Copilot agents intro: 'Learn how to use {% data variables.product.prodname_copilot %} agents.' versions: feature: copilot @@ -10,4 +10,3 @@ children: - /copilot-coding-agent - /copilot-code-review --- - diff --git a/content/copilot/how-tos/ai-models/creating-a-custom-model-for-github-copilot.md b/content/copilot/how-tos/ai-models/creating-a-custom-model-for-github-copilot.md index f84454fd3f8e..eb5c5705abd2 100644 --- a/content/copilot/how-tos/ai-models/creating-a-custom-model-for-github-copilot.md +++ b/content/copilot/how-tos/ai-models/creating-a-custom-model-for-github-copilot.md @@ -5,7 +5,7 @@ intro: 'You can fine-tune {% data variables.product.prodname_copilot_short %} co permissions: 'Owners of organizations enrolled in the {% data variables.release-phases.public_preview %}.' product: '{% data reusables.copilot.ce-product-callout %}' versions: - feature: copilot-custom-models + feature: copilot topics: - Copilot redirect_from: diff --git a/content/copilot/how-tos/ai-models/index.md b/content/copilot/how-tos/ai-models/index.md index 4894ef2ebe21..6df260dfda89 100644 --- a/content/copilot/how-tos/ai-models/index.md +++ b/content/copilot/how-tos/ai-models/index.md @@ -1,6 +1,6 @@ --- title: AI models for Copilot -shortTitle: AI models +shortTitle: Use AI models intro: 'Learn how to use alternative large language models for {% data variables.product.prodname_copilot %}.' versions: feature: copilot diff --git a/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/context-passing-for-your-agent.md b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/context-passing-for-your-agent.md index 81251e321e7f..430497dca19a 100644 --- a/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/context-passing-for-your-agent.md +++ b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/context-passing-for-your-agent.md @@ -5,7 +5,7 @@ versions: feature: copilot-extensions topics: - Copilot -shortTitle: Context passing +shortTitle: Use context passing type: how_to redirect_from: - /copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/context-passing-for-your-agent @@ -65,7 +65,7 @@ The following code shows an example object for `client.file`: // The reference type. "type": "client.file", "data": { - // The full content of the active file. + // The full content of the active file. "content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit", "language": "plaintext" }, diff --git a/content/copilot/how-tos/build-copilot-extensions/index.md b/content/copilot/how-tos/build-copilot-extensions/index.md index e222b4a5b397..4dfcdef43f30 100644 --- a/content/copilot/how-tos/build-copilot-extensions/index.md +++ b/content/copilot/how-tos/build-copilot-extensions/index.md @@ -1,6 +1,6 @@ --- title: Copilot Extensions -shortTitle: Copilot Extensions +shortTitle: Use Copilot Extensions intro: 'Learn how to integrate external tools with {% data variables.product.prodname_copilot_short %}.' versions: feature: copilot @@ -17,4 +17,3 @@ children: redirect_from: - /copilot/building-copilot-extensions --- - diff --git a/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github-mobile.md b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github-mobile.md index c0f1cd231861..84fb476a630a 100644 --- a/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github-mobile.md +++ b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github-mobile.md @@ -6,7 +6,7 @@ topics: - Mobile versions: feature: copilot-chat-for-mobile -shortTitle: Chat in Mobile +shortTitle: Use Chat in Mobile redirect_from: - /copilot/github-copilot-chat/using-github-copilot-chat-in-github-mobile - /copilot/github-copilot-chat/copilot-chat-in-github-mobile/using-github-copilot-chat-in-github-mobile diff --git a/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github.md b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github.md index 29929dea4c1f..6392f730340e 100644 --- a/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github.md +++ b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github.md @@ -1,6 +1,6 @@ --- title: Asking GitHub Copilot questions in GitHub -shortTitle: Chat in GitHub +shortTitle: Use Chat in GitHub intro: 'You can use {% data variables.copilot.copilot_chat_dotcom %} to answer general questions about software development, or specific questions about the issues or code in a repository.' versions: feature: copilot diff --git a/content/copilot/how-tos/chat/asking-github-copilot-questions-in-windows-terminal.md b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-windows-terminal.md index 35be0659ed29..683fa4c20080 100644 --- a/content/copilot/how-tos/chat/asking-github-copilot-questions-in-windows-terminal.md +++ b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-windows-terminal.md @@ -3,7 +3,7 @@ title: Asking GitHub Copilot questions in Windows Terminal intro: 'You can use {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %} to get suggestions and explanations for the command line.' topics: - Copilot -shortTitle: Copilot in Windows Terminal +shortTitle: Use Chat in Windows Terminal versions: feature: copilot redirect_from: diff --git a/content/copilot/how-tos/chat/asking-github-copilot-questions-in-your-ide.md b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-your-ide.md index b83bf2c6158e..9d1eb3c98042 100644 --- a/content/copilot/how-tos/chat/asking-github-copilot-questions-in-your-ide.md +++ b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-your-ide.md @@ -13,7 +13,7 @@ redirect_from: defaultTool: vscode versions: feature: copilot -shortTitle: Chat in IDE +shortTitle: Use Chat in IDE --- {% vscode %} diff --git a/content/copilot/how-tos/chat/getting-started-with-prompts-for-copilot-chat.md b/content/copilot/how-tos/chat/getting-started-with-prompts-for-copilot-chat.md index 1aac77c6ade4..a8fab16c2571 100644 --- a/content/copilot/how-tos/chat/getting-started-with-prompts-for-copilot-chat.md +++ b/content/copilot/how-tos/chat/getting-started-with-prompts-for-copilot-chat.md @@ -11,7 +11,7 @@ redirect_from: - /copilot/using-github-copilot/guides-on-using-github-copilot/getting-started-with-prompts-for-copilot-chat - /copilot/using-github-copilot/copilot-chat/getting-started-with-prompts-for-copilot-chat - /copilot/get-started/getting-started-with-prompts-for-copilot-chat -shortTitle: Get started with chat +shortTitle: Get started with Chat --- You can ask {% data variables.copilot.copilot_chat_short %} specific questions about your project or general software questions. You can also ask {% data variables.copilot.copilot_chat_short %} to write code, fix errors, write tests, and document code. diff --git a/content/copilot/how-tos/chat/index.md b/content/copilot/how-tos/chat/index.md index 7810848c3ee9..2aa459ad4b0e 100644 --- a/content/copilot/how-tos/chat/index.md +++ b/content/copilot/how-tos/chat/index.md @@ -1,6 +1,6 @@ --- title: Copilot Chat -shortTitle: Chat +shortTitle: Use Chat intro: 'Learn how to use {% data variables.copilot.copilot_chat_short %} across different environments.' versions: feature: copilot @@ -16,4 +16,3 @@ children: - /asking-github-copilot-questions-in-github - /asking-github-copilot-questions-in-github-mobile --- - diff --git a/content/copilot/how-tos/completions/index.md b/content/copilot/how-tos/completions/index.md index bef6408d4d2c..ac66150bbbf6 100644 --- a/content/copilot/how-tos/completions/index.md +++ b/content/copilot/how-tos/completions/index.md @@ -1,6 +1,6 @@ --- title: Get suggestions from GitHub Copilot -shortTitle: Completions +shortTitle: Get code suggestions intro: 'Learn how to use {% data variables.product.prodname_copilot %}.' versions: feature: copilot @@ -11,4 +11,3 @@ children: - /using-copilot-text-completion - /finding-public-code-that-matches-github-copilot-suggestions --- - diff --git a/content/copilot/how-tos/completions/using-copilot-text-completion.md b/content/copilot/how-tos/completions/using-copilot-text-completion.md index 0ea31e10476d..accc3fb1ee0c 100644 --- a/content/copilot/how-tos/completions/using-copilot-text-completion.md +++ b/content/copilot/how-tos/completions/using-copilot-text-completion.md @@ -4,7 +4,7 @@ shortTitle: Write PR descriptions allowTitleToDifferFromFilename: true intro: 'Write pull request descriptions more quickly and accurately with {% data variables.copilot.copilot_autocomplete_pr %}.' versions: - feature: copilot-enterprise + feature: copilot type: how_to permissions: 'Members of an enterprise with a subscription to [{% data variables.copilot.copilot_enterprise %}](/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise)' topics: diff --git a/content/copilot/how-tos/content-exclusion/index.md b/content/copilot/how-tos/content-exclusion/index.md index 679f6990438f..76bb4b2231b2 100644 --- a/content/copilot/how-tos/content-exclusion/index.md +++ b/content/copilot/how-tos/content-exclusion/index.md @@ -1,6 +1,6 @@ --- title: Configure and audit content exclusion -shortTitle: Content exclusion +shortTitle: Configure content exclusion intro: 'You can prevent {% data variables.product.prodname_copilot_short %} from accessing certain content, and review any changes to these settings.' versions: feature: copilot @@ -12,4 +12,3 @@ children: redirect_from: - /copilot/managing-copilot/configuring-and-auditing-content-exclusion --- - diff --git a/content/copilot/how-tos/content-exclusion/reviewing-changes-to-content-exclusions-for-github-copilot.md b/content/copilot/how-tos/content-exclusion/reviewing-changes-to-content-exclusions-for-github-copilot.md index f9c73edf97db..248eb4118505 100644 --- a/content/copilot/how-tos/content-exclusion/reviewing-changes-to-content-exclusions-for-github-copilot.md +++ b/content/copilot/how-tos/content-exclusion/reviewing-changes-to-content-exclusions-for-github-copilot.md @@ -1,6 +1,6 @@ --- title: Reviewing changes to content exclusions for GitHub Copilot -shortTitle: Content exclusion changes +shortTitle: Review changes intro: You can monitor changes to content exclusions in your repositories and organizations. permissions: Organization owners product: '{% data reusables.gated-features.copilot-business-and-enterprise %}' diff --git a/content/copilot/how-tos/context/copilot-spaces/index.md b/content/copilot/how-tos/context/copilot-spaces/index.md index 463bce8a2551..4684283a5319 100644 --- a/content/copilot/how-tos/context/copilot-spaces/index.md +++ b/content/copilot/how-tos/context/copilot-spaces/index.md @@ -1,5 +1,6 @@ --- title: Copilot Spaces +shortTitle: Use Copilot Spaces intro: 'Organize and centralize relevant content into {% data variables.copilot.copilot_spaces_short %} that ground {% data variables.product.prodname_copilot_short %}’s responses in the right context for a specific task.' versions: feature: copilot @@ -11,4 +12,3 @@ children: redirect_from: - /copilot/using-github-copilot/copilot-spaces --- - diff --git a/content/copilot/how-tos/context/index.md b/content/copilot/how-tos/context/index.md index 362c04f4b0d0..da9b0660427e 100644 --- a/content/copilot/how-tos/context/index.md +++ b/content/copilot/how-tos/context/index.md @@ -1,6 +1,6 @@ --- title: Provide context to GitHub Copilot -shortTitle: Context +shortTitle: Provide context intro: 'Learn how to give {% data variables.product.prodname_copilot %} relevant information to increase the quality of responses.' versions: feature: copilot @@ -15,4 +15,3 @@ children: redirect_from: - /copilot/customizing-copilot --- - diff --git a/content/copilot/how-tos/custom-instructions/adding-organization-custom-instructions-for-github-copilot.md b/content/copilot/how-tos/custom-instructions/adding-organization-custom-instructions-for-github-copilot.md index 60c19685fa85..fb13de069eb3 100644 --- a/content/copilot/how-tos/custom-instructions/adding-organization-custom-instructions-for-github-copilot.md +++ b/content/copilot/how-tos/custom-instructions/adding-organization-custom-instructions-for-github-copilot.md @@ -1,11 +1,11 @@ --- title: Adding organization custom instructions for GitHub Copilot -shortTitle: Organization custom instructions +shortTitle: Add organization instructions intro: 'Customize {% data variables.copilot.copilot_chat %} responses for members of your organization.' permissions: Organization owners product: 'Organizations with a {% data variables.copilot.copilot_for_business %} or {% data variables.copilot.copilot_enterprise %} plan' versions: - feature: copilot-org-instructions + feature: copilot topics: - Copilot redirect_from: diff --git a/content/copilot/how-tos/custom-instructions/adding-personal-custom-instructions-for-github-copilot.md b/content/copilot/how-tos/custom-instructions/adding-personal-custom-instructions-for-github-copilot.md index 94ea1906a6f9..bb048554a6dc 100644 --- a/content/copilot/how-tos/custom-instructions/adding-personal-custom-instructions-for-github-copilot.md +++ b/content/copilot/how-tos/custom-instructions/adding-personal-custom-instructions-for-github-copilot.md @@ -1,6 +1,6 @@ --- title: Adding personal custom instructions for GitHub Copilot -shortTitle: Personal custom instructions +shortTitle: Add personal instructions intro: 'Customize {% data variables.copilot.copilot_chat %} responses to match your personal preferences.' versions: feature: copilot diff --git a/content/copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot.md b/content/copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot.md index 39989107111d..e9d2b47585ee 100644 --- a/content/copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot.md +++ b/content/copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot.md @@ -1,6 +1,6 @@ --- title: Adding repository custom instructions for GitHub Copilot -shortTitle: Repository custom instructions +shortTitle: Add repository instructions intro: 'Create a file in a repository that gives {% data variables.product.prodname_copilot_short %} additional context for the work it does in that repository.' redirect_from: - /copilot/customizing-copilot/adding-custom-instructions-for-github-copilot @@ -17,27 +17,12 @@ topics: This version of this article is for using repository custom instructions on the {% data variables.product.github %} website. Click the tabs above for information on using custom instructions in other environments. -## About repository custom instructions for {% data variables.product.prodname_copilot_short %} - -Repository custom instructions let you provide {% data variables.product.prodname_copilot_short %} with repository-specific guidance and preferences. For a full introduction to custom instructions, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=webui). - -{% data reusables.copilot.repository-custom-instructions-support %} -* **{% data variables.copilot.copilot_coding_agent %}** -* **{% data variables.copilot.copilot_code-review_short %}** - {% endwebui %} {% vscode %} This version of this article is for using repository custom instructions and prompt files in {% data variables.product.prodname_vscode_shortname %}. Click the tabs above for instructions on using custom instructions in other environments. -## About repository custom instructions and prompt files for {% data variables.product.prodname_copilot_short %} - -You can provide {% data variables.product.prodname_copilot_short %} with repository-wide instructions or reusable prompt files to give it context and guidance when working in {% data variables.product.prodname_vscode_shortname %}. For a full introduction to repository custom instructions and prompt files, including examples, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=vscode). - -{% data reusables.copilot.repository-custom-instructions-support %} -* **{% data variables.copilot.copilot_code-review_short %}** - {% endvscode %} {% visualstudio %} @@ -46,13 +31,6 @@ You can provide {% data variables.product.prodname_copilot_short %} with reposit This version of this article is for using repository custom instructions in {% data variables.product.prodname_vs %}. Click the tabs above for instructions on using custom instructions in other environments. -## About repository custom instructions for {% data variables.product.prodname_copilot_short %} - -Repository custom instructions let you provide {% data variables.product.prodname_copilot_short %} with repository-specific guidance and preferences. For a full introduction to custom instructions, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=visualstudio). - -{% data reusables.copilot.repository-custom-instructions-support %} -* **{% data variables.copilot.copilot_code-review_short %}** - {% endvisualstudio %} {% jetbrains %} @@ -61,12 +39,6 @@ Repository custom instructions let you provide {% data variables.product.prodnam This version of this article is for using repository custom instructions in JetBrains IDEs. Click the tabs above for instructions on using custom instructions in other environments. -## About repository custom instructions for {% data variables.copilot.copilot_chat %} - -Repository custom instructions let you provide {% data variables.product.prodname_copilot_short %} with repository-specific guidance and preferences. For a full introduction to custom instructions, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=jetbrains). - -{% data reusables.copilot.repository-custom-instructions-support %} - {% endjetbrains %} {% xcode %} @@ -75,14 +47,14 @@ Repository custom instructions let you provide {% data variables.product.prodnam This version of this article is for using repository custom instructions in Xcode. Click the tabs above for instructions on using custom instructions in other environments. -## About repository custom instructions for {% data variables.copilot.copilot_chat %} +{% endxcode %} + +## About repository custom instructions for {% data variables.product.prodname_copilot_short %} -Repository custom instructions let you provide {% data variables.product.prodname_copilot_short %} with repository-specific guidance and preferences. For a full introduction to custom instructions, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=xcode). +Repository custom instructions let you provide {% data variables.product.prodname_copilot_short %} with repository-specific guidance and preferences. {% data reusables.copilot.repository-custom-instructions-support %} -{% endxcode %} - ## Prerequisites for repository custom instructions * You must have a custom instructions file (see the instructions below). @@ -123,6 +95,8 @@ Repository custom instructions let you provide {% data variables.product.prodnam {% jetbrains %} +JetBrains IDEs support a single `.github/copilot-instructions.md` custom instructions file stored in the repository. + You can create a custom instructions file in your repository using the {% data variables.product.prodname_copilot_short %} settings page, or you can create the file manually. Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility. @@ -164,6 +138,8 @@ Once saved, these instructions will apply globally across all workspaces in JetB {% xcode %} +Xcode supports a single `.github/copilot-instructions.md` custom instructions file stored in the repository. + You can create a custom instructions file in your repository via the {% data variables.product.prodname_copilot_short %} settings page. Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility. @@ -176,6 +152,13 @@ Whitespace between instructions is ignored, so the instructions can be written a {% vscode %} +{% data variables.product.prodname_vscode_shortname %} supports either: + +* A single `.github/copilot-instructions.md` custom instructions file stored in the repository +* One or more `.instructions.md` files stored within `.github/instructions` in the repository. Each file can specify `applyTo` frontmatter to define what files or directories its instructions apply to. + +### Using a single `.github/copilot-instructions.md` file + 1. In the root of your repository, create a file named `.github/copilot-instructions.md`. Create the `.github` directory if it does not already exist. @@ -184,10 +167,32 @@ Whitespace between instructions is ignored, so the instructions can be written a Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility. +### Using one or more `.instructions.md` files + +1. Create the `.github/instructions` directory if it does not already exist. + +1. Create one or more `.instructions.md` files, adding natural language instructions to the file(s). + + Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility. + +1. Specify what files or directories the instructions apply to by adding `applyTo` frontmatter to the Markdown files, using glob syntax. + + ```markdown + --- + applyTo: "app/models/**/*.rb" + --- + + Add custom instructions here + ``` + + To apply the instructions to all files, use the `**` pattern. + {% endvscode %} {% visualstudio %} +{% data variables.product.prodname_vs %} supports a single `.github/copilot-instructions.md` custom instructions file stored in the repository. + 1. In the root of your repository, create a file named `.github/copilot-instructions.md`. Create the `.github` directory if it does not already exist. @@ -200,6 +205,12 @@ Whitespace between instructions is ignored, so the instructions can be written a {% webui %} +**{% data variables.copilot.copilot_chat_short %}** on the {% data variables.product.github %} website and **{% data variables.copilot.copilot_code-review_short %}** support a single `.github/copilot-instructions.md` custom instructions file stored in the repository. + +In addition, **{% data variables.copilot.copilot_coding_agent %}** supports one or more `.instructions.md` files stored within `.github/instructions` in the repository. Each file can specify `applyTo` frontmatter to define what files or directories its instructions apply to. + +### Using a single `.github/copilot-instructions.md` file + 1. In the root of your repository, create a file named `.github/copilot-instructions.md`. Create the `.github` directory if it does not already exist. @@ -208,7 +219,25 @@ Whitespace between instructions is ignored, so the instructions can be written a Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility. -To see your instructions in action, go to [https://github.com/copilot](https://github.com/copilot), attach the repository containing the instructions file, and start a conversation. +### Using one or more `.instructions.md` files + +1. Create the `.github/instructions` directory if it does not already exist. + +1. Create one or more `.instructions.md` files, adding natural language instructions to the file(s). + + Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility. + +1. Specify what files or directories the instructions apply to by adding `applyTo` frontmatter to the Markdown files, using glob syntax. + + ```markdown + --- + applyTo: "app/models/**/*.rb" + --- + + Add custom instructions here + ``` + + To apply the instructions to all files, use the `**` pattern. {% endwebui %} @@ -222,16 +251,16 @@ Did you successfully add a custom instructions file to your repository? ## Writing effective repository custom instructions -The instructions you add to the `.github/copilot-instructions.md` file should be short, self-contained statements that provide {% data variables.product.prodname_copilot_short %} with relevant information to help it work in this repository. Because the instructions are sent with every chat message, they should be broadly applicable to most requests you will make in the context of the repository. +The instructions you add to your custom instruction file(s) should be short, self-contained statements that provide {% data variables.product.prodname_copilot_short %} with relevant information to help it work in this repository. Because the instructions are sent with every chat message, they should be broadly applicable to most requests you will make in the context of the repository. -The exact structure you utilize for your instructions file will vary by project and need, but the following guidelines provide a good starting point: +The exact structure you utilize for your instructions file(s) will vary by project and need, but the following guidelines provide a good starting point: * Provide an overview of the project you're working on, including its purpose, goals, and any relevant background information. * Include the folder structure of the repository, including any important directories or files that are relevant to the project. * Specify the coding standards and conventions that should be followed, such as naming conventions, formatting rules, and best practices. * Include any specific tools, libraries, or frameworks that are used in the project, along with any relevant version numbers or configurations. -The following instructions file is an example of these practices in action: +The following instructions file(s) is an example of these practices in action: ```markdown # Project Overview @@ -283,7 +312,7 @@ Answer all questions in less than 1000 characters, and words of no more than 12 ## Repository custom instructions in use -The instructions in the `.github/copilot-instructions.md` file are available for use by {% data variables.copilot.copilot_chat_short %} as soon as you save the file. The complete set of instructions will be automatically added to requests that you submit to {% data variables.product.prodname_copilot_short %} in the context of that repository. For example, they are added to the prompt you submit to {% data variables.copilot.copilot_chat_short %}. +The instructions in the file(s) are available for use by {% data variables.copilot.copilot_chat_short %} as soon as you save the file(s). The complete set of instructions will be automatically added to requests that you submit to {% data variables.product.prodname_copilot_short %} in the context of that repository. For example, they are added to the prompt you submit to {% data variables.copilot.copilot_chat_short %}. {% webui %} diff --git a/content/copilot/how-tos/custom-instructions/index.md b/content/copilot/how-tos/custom-instructions/index.md index 2f0ea38de20a..0ca5fddc9fc6 100644 --- a/content/copilot/how-tos/custom-instructions/index.md +++ b/content/copilot/how-tos/custom-instructions/index.md @@ -1,6 +1,6 @@ --- title: Configure custom instructions for GitHub Copilot -shortTitle: Custom instructions +shortTitle: Configure custom instructions intro: 'Learn how to give {% data variables.product.prodname_copilot %} persistent instructions and customize responses according to your needs.' versions: feature: copilot @@ -11,4 +11,3 @@ children: - /adding-repository-custom-instructions-for-github-copilot - /adding-organization-custom-instructions-for-github-copilot --- - diff --git a/content/copilot/how-tos/github-flow/index.md b/content/copilot/how-tos/github-flow/index.md index f373783061c4..f75ec992a8d9 100644 --- a/content/copilot/how-tos/github-flow/index.md +++ b/content/copilot/how-tos/github-flow/index.md @@ -1,6 +1,6 @@ --- -title: Copilot in the GitHub flow -shortTitle: GitHub flow +title: Use Copilot for common tasks +shortTitle: Use Copilot for common tasks intro: '{% data variables.product.prodname_copilot %} enhances and integrates with many different {% data variables.product.github %} features.' versions: feature: copilot @@ -11,4 +11,3 @@ children: - /creating-a-pull-request-summary-with-github-copilot - /using-github-copilot-in-the-command-line --- - diff --git a/content/copilot/how-tos/personal-settings/index.md b/content/copilot/how-tos/personal-settings/index.md index 7f6008ec9e22..d2d39b9f186d 100644 --- a/content/copilot/how-tos/personal-settings/index.md +++ b/content/copilot/how-tos/personal-settings/index.md @@ -1,6 +1,5 @@ --- title: Configure personal settings -shortTitle: Personal settings intro: 'You can manage the configuration of {% data variables.product.prodname_copilot %} in a supported IDE or on {% data variables.product.github %}.' versions: feature: copilot @@ -15,4 +14,3 @@ redirect_from: - /copilot/configuring-github-copilot - /copilot/managing-copilot/configure-personal-settings --- - diff --git a/content/copilot/how-tos/spending/index.md b/content/copilot/how-tos/spending/index.md index 00da3e2df6a3..a8d22988771e 100644 --- a/content/copilot/how-tos/spending/index.md +++ b/content/copilot/how-tos/spending/index.md @@ -1,6 +1,6 @@ --- title: Manage and monitor spending for Copilot -shortTitle: Spending +shortTitle: Manage and track spending intro: 'Manage and track spending on Copilot for your company.' versions: feature: copilot @@ -13,4 +13,3 @@ children: redirect_from: - /copilot/how-tos/premium-requests --- - diff --git a/content/copilot/how-tos/spending/manage-for-enterprise.md b/content/copilot/how-tos/spending/manage-for-enterprise.md index 22f5b8fb49e7..72e51f8b01c5 100644 --- a/content/copilot/how-tos/spending/manage-for-enterprise.md +++ b/content/copilot/how-tos/spending/manage-for-enterprise.md @@ -1,6 +1,6 @@ --- title: Managing the premium request allowance for users in your enterprise -shortTitle: Enterprise premium requests +shortTitle: Manage for your enterprise intro: 'Change the default spending limit or upgrade users to {% data variables.copilot.copilot_enterprise_short %}.' permissions: 'Enterprise owners' versions: diff --git a/content/copilot/how-tos/troubleshoot/index.md b/content/copilot/how-tos/troubleshoot/index.md index 560babf8e65e..bffbf5e05ae3 100644 --- a/content/copilot/how-tos/troubleshoot/index.md +++ b/content/copilot/how-tos/troubleshoot/index.md @@ -1,6 +1,6 @@ --- title: Troubleshoot GitHub Copilot -shortTitle: Troubleshoot +shortTitle: Troubleshoot Copilot intro: 'These guides provide information for troubleshooting {% data variables.product.prodname_copilot %}.' versions: fpt: '*' diff --git a/content/copilot/how-tos/troubleshoot/troubleshooting-common-issues-with-github-copilot.md b/content/copilot/how-tos/troubleshoot/troubleshooting-common-issues-with-github-copilot.md index df9d00a25f7c..01e337a15e32 100644 --- a/content/copilot/how-tos/troubleshoot/troubleshooting-common-issues-with-github-copilot.md +++ b/content/copilot/how-tos/troubleshoot/troubleshooting-common-issues-with-github-copilot.md @@ -5,7 +5,7 @@ versions: feature: copilot topics: - Copilot -shortTitle: Common issues with GitHub Copilot +shortTitle: Troubleshoot common issues redirect_from: - /copilot/troubleshooting-github-copilot/troubleshooting-common-issues-with-github-copilot - /copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat-in-ides diff --git a/content/copilot/how-tos/troubleshoot/troubleshooting-firewall-settings-for-github-copilot.md b/content/copilot/how-tos/troubleshoot/troubleshooting-firewall-settings-for-github-copilot.md index a1ea91306739..1f785e299303 100644 --- a/content/copilot/how-tos/troubleshoot/troubleshooting-firewall-settings-for-github-copilot.md +++ b/content/copilot/how-tos/troubleshoot/troubleshooting-firewall-settings-for-github-copilot.md @@ -7,7 +7,7 @@ topics: - Networking versions: feature: copilot -shortTitle: Connectivity security settings +shortTitle: Troubleshoot firewall settings redirect_from: - /copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot --- diff --git a/content/copilot/how-tos/troubleshoot/troubleshooting-network-errors-for-github-copilot.md b/content/copilot/how-tos/troubleshoot/troubleshooting-network-errors-for-github-copilot.md index 179ad3b33794..4aa05b070369 100644 --- a/content/copilot/how-tos/troubleshoot/troubleshooting-network-errors-for-github-copilot.md +++ b/content/copilot/how-tos/troubleshoot/troubleshooting-network-errors-for-github-copilot.md @@ -10,7 +10,7 @@ redirect_from: - /copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot versions: feature: copilot -shortTitle: Network errors +shortTitle: Troubleshoot network errors --- If you're working on company equipment and connecting to a corporate network, you may be connecting to the Internet via a VPN or an HTTP proxy server. In some cases, these types of network setups may prevent {% data variables.product.prodname_copilot %} from connecting to {% data variables.product.prodname_dotcom %}'s server. For more information about the options for setting up proxies with {% data variables.product.prodname_copilot %}, see [AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot). diff --git a/content/copilot/responsible-use-of-github-copilot-features/index.md b/content/copilot/responsible-use-of-github-copilot-features/index.md index 9bc7a09237d9..334e507692fc 100644 --- a/content/copilot/responsible-use-of-github-copilot-features/index.md +++ b/content/copilot/responsible-use-of-github-copilot-features/index.md @@ -18,4 +18,5 @@ children: - /responsible-use-of-github-copilot-text-completion - /responsible-use-of-github-copilot-code-review - /responsible-use-of-copilot-coding-agent-on-githubcom + - /responsible-use-of-github-spark --- diff --git a/content/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-spark.md b/content/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-spark.md new file mode 100644 index 000000000000..8a6648a91358 --- /dev/null +++ b/content/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-spark.md @@ -0,0 +1,109 @@ +--- +title: Responsible use of GitHub Spark +shortTitle: Spark +intro: 'Learn how to use {% data variables.product.prodname_spark %} responsibly by understanding its purposes, capabilities, and limitations.' +versions: + feature: spark +topics: + - Copilot + - AI +type: rai +--- + +{% data reusables.rai.spark-preview-note %} + +## About {% data variables.product.prodname_spark %} + +{% data variables.product.prodname_spark_short %} is a {% data variables.product.prodname_copilot_short %}-powered platform for creating and sharing applications (“sparks”) that can be tailored to individual needs and accessed seamlessly across desktop and mobile devices \- without requiring users to write or deploy code. + +{% data variables.product.prodname_spark_short %} offers a natural language centric development environment for application creation and a fully managed runtime environment that scales with your sparks’ needs. {% data variables.product.prodname_spark_short %} eliminates the need to manually manage infrastructure or stitch together multiple tools, letting you focus on building. + +### Input processing + +> [!NOTE] {% data variables.product.prodname_spark_short %} currently leverages {% data variables.copilot.copilot_claude_sonnet_40 %}. This model is subject to change. + +Input prompts in {% data variables.product.prodname_spark_short %} are pre-processed by {% data variables.product.prodname_copilot_short %}, augmented with contextual information from your current {% data variables.product.prodname_spark_short %} inputs and sent to a large language model powered agent within your development environment. Included context includes information from your spark such as code from your current application, previous prompts supplied in the {% data variables.product.prodname_spark_short %} interface, and any error logs from your spark’s development environment. + +The system is only designed to generate code based on submitted prompts. It is not capable of conversational interactions. English is the preferred language for submitted prompts. + +### Language model analysis + +The prompt is then passed through a large language model, which is a neural network that has been trained on a large body of text data. The language model analyzes the input prompt to help the agent reason on the task and leverage necessary tools. + +### Agent execution + +The agent which runs in your development environment accepts your prompt and the additional context passed, and decides how to update your spark to satisfy your request. The agent is able to operate your development environment by writing code, running commands, and reading execution outputs. All of the actions taken by the agent are to ensure functional, accurate code to execute your prompt. The only output from the agent is your application code. + +### {% data variables.product.prodname_spark_short %} frameworks + +The {% data variables.product.prodname_spark_short %} agent is trained to use frameworks and SDKs supplied by {% data variables.product.prodname_spark_short %} that ensure modern design and secure deployments seamlessly integrated into {% data variables.product.prodname_spark_short %}’s runtime component. The design framework is designed to be flexible and modular, enabling you to easily modify the theme to match your desired look and feel. {% data variables.product.prodname_spark_short %}’s runtime integration, accessible via the SDK, uses best practices for web deployments to ensure secure, scalable deployments. + +### Adding inference capabilities to your spark + +{% data variables.product.prodname_spark_short %}’s SDK natively integrates with {% data variables.product.prodname_github_models %}, allowing you to incorporate model inference into your spark. If {% data variables.product.prodname_spark_short %} determines that your application requires inference capabilities, it will add them using the {% data variables.product.prodname_spark_short %} SDK. + +{% data variables.product.prodname_spark_short %} gives you the tools to create, modify, and test the prompts that will be used with these inference capabilities. {% data variables.product.prodname_spark_short %} does not do any testing of the prompts that you create within your application, so you must ensure that your included capabilities act as intended. For more information on responsible use within {% data variables.product.prodname_github_models %}, see the [AUTOTITLE](/github-models/responsible-use-of-github-models). + +### Data processing + +{% data variables.product.prodname_spark_short %} collects data to operate the service - this includes prompts, suggestions, and code snippets necessary to ensuring continuity between sessions. {% data variables.product.prodname_spark_short %} also collects additional usage information including usage patterns, submitted feedback, and performance telemetry. + +## Use cases for {% data variables.product.prodname_spark_short %} + +### Building and deploying full stack web applications + +You can use {% data variables.product.prodname_spark_short %} to build full stack web applications for you using natural language. {% data variables.product.prodname_spark_short %}’s integrated runtime environment allows you to deploy these applications to the public internet. You can define permissions to these deployed applications based on {% data variables.product.github %} account visibility, allowing them to be visible to the general public, specific {% data variables.product.github %} members, members of your team or organization, or just you. Sparks can be anything \- from board game score trackers to full software-as-a-service products \- however whatever you deploy remains subject to {% data variables.product.github %}’s [Terms](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot) for user generated content. + +### Prototyping ideas + +{% data variables.product.prodname_spark_short %} helps developers, designers, product managers, or other builders rapidly prototype ideas without needing to build applications from scratch or construct complex mockups. These prototypes can be deployed for ease of sharing, or can remain unpublished as a way for builders to instantly see their vision. + +## Improving performance for {% data variables.product.prodname_spark_short %} + +{% data variables.product.prodname_spark_short %} can build a wide variety of applications, and iterate on them over time to increase complexity as new requirements are surfaced. To enhance performance and address some limitations of {% data variables.product.prodname_spark_short %}, there are various best practices you can adopt. For more information about the limitations of {% data variables.product.prodname_spark_short %}, see [Limitations of {% data variables.product.prodname_spark_short %}](#limitations-of-github-spark). + +### Keep your prompts specific and on topic + +{% data variables.product.prodname_spark_short %} is intended to build and iterate on your spark. The more specific you can be about the intended behaviors and interactions, the better the output will be from {% data variables.product.prodname_spark_short %}. Incorporating relevant context such as specific scenarios, mockups, or specifications will help {% data variables.product.prodname_spark_short %} understand your intent, which will improve the output you receive. + +{% data variables.product.prodname_spark_short %} also incorporates context from previous prompts into each subsequent revision it generates. Submitting off-topic prompts may hinder performance on subsequent revisions. Therefore try to keep your prompts as relevant as possible to the application you are building. + +### Use targeted edits appropriately + +Targeted edits in {% data variables.product.prodname_spark_short %} allow you to specify elements within your application, letting you refine style, substance, or behavior of individual elements of your application. These targeted edits are an excellent way to constrain edit surface area and express intent to {% data variables.product.prodname_spark_short %}. Using targeted edits when possible (rather than global prompts) will result in more accurate changes, as well as fewer side effects in your application as {% data variables.product.prodname_spark_short %} generates new revisions. + +### Verify {% data variables.product.prodname_spark_short %}’s output + +While {% data variables.product.prodname_spark_short %} is an extremely powerful tool, it may still make mistakes. These mistakes can be misunderstandings of your goals, or more simple syntax errors within your generated spark. You should always use {% data variables.product.prodname_spark_short %}’s provided application preview to verify that your spark behaves as intended in different scenarios. If you are comfortable with code, it is also best practice to ensure the generated code is up to your code quality standards. + +## Limitations of GitHub Spark + +### Interpretation of user intent + +{% data variables.product.prodname_spark_short %} is not always correct in its interpretation of your intent. You should always use {% data variables.product.prodname_spark_short %}’s provided preview to confirm accurate behavior within your spark. + +### Limited scope + +{% data variables.product.prodname_spark_short %} is backed by {% data variables.product.prodname_copilot_short %}, and therefore has been trained on a large body of code and relevant applications. However it may still struggle with complex or truly novel applications. {% data variables.product.prodname_spark_short %} will perform best on common/personal application scenarios (e.g. productivity tools, learning aids, life management utilities), and when the natural language instruction is provided in English. + +### Security limitations + +While {% data variables.product.prodname_spark_short %}’s runtime follows best practices for application deployment, it does generate code probabilistically, which can potentially introduce vulnerabilities especially if those vulnerabilities are common in the training set of applications. You should be careful when building applications that manage personal or sensitive data and always review and test the generated application thoroughly. + +### Legal and regulatory considerations + +Users need to evaluate potential specific legal and regulatory obligations when using any AI services and solutions, which may not be appropriate for use in every industry or scenario. Additionally, AI services or solutions are not designed for and may not be used in ways prohibited in applicable terms of service and relevant codes of conduct. + +### Offensive content + +{% data variables.product.prodname_spark_short %} has built-in protections against harmful, hateful, or offensive content. Please report any examples of offensive content to copilot-safety@github.com. Please include your spark’s URL so that we can identify the spark. + +You can report problematic or illegal content via Feedback, or you can report a spark as abuse or spam. See [AUTOTITLE](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam) and {% data variables.product.github %}'s [Content Removal Policies](/free-pro-team@latest/site-policy/content-removal-policies). + +## Further Reading + +* [AUTOTITLE](/copilot/tutorials/building-your-first-app-in-minutes-with-github-spark) +* [AUTOTITLE](/copilot/tutorials/building-ai-app-prototypes) +* [AUTOTITLE](/copilot/concepts/copilot-billing/about-billing-for-github-spark) +* [AUTOTITLE](/github-models/responsible-use-of-github-models) +* [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-pre-release-license-terms) diff --git a/content/copilot/tutorials/building-ai-app-prototypes.md b/content/copilot/tutorials/building-ai-app-prototypes.md new file mode 100644 index 000000000000..e2ae6d8d4bbb --- /dev/null +++ b/content/copilot/tutorials/building-ai-app-prototypes.md @@ -0,0 +1,183 @@ +--- +title: Building and deploying AI-powered apps with GitHub Spark +shortTitle: Build intelligent apps with Spark +allowTitleToDifferFromFilename: true +intro: 'Learn how to build and deploy an intelligent web app with natural language using {% data variables.product.prodname_spark %}.' +versions: + feature: spark +product: 'Anyone with a {% data variables.copilot.copilot_pro_plus_short %} license can use {% data variables.product.prodname_spark_short %}.' +topics: + - Copilot +--- + +> [!NOTE] +> * {% data reusables.spark.preview-note-spark %} +> * The {% data variables.product.prodname_copilot %} setting that blocks suggestions matching public code may not work as intended when using {% data variables.product.prodname_spark_short %}. See [AUTOTITLE](/copilot/how-tos/manage-your-account/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-suggestions-matching-public-code). + +## Introduction + +With {% data variables.product.prodname_spark %}, you can describe what you want in natural language and get a fullstack web app with data storage, AI features, and {% data variables.product.github %} authentication built in. You can iterate using prompts, visual tools, or code, and then deploy with a click to a fully managed runtime. + +{% data variables.product.prodname_spark_short %} is seamlessly integrated with {% data variables.product.github %} so you can develop your spark via a synced {% data variables.product.github %} codespace with {% data variables.product.prodname_copilot_short %} for advanced editing. You can also create a repository for team collaboration, and leverage {% data variables.product.github %}'s ecosystem of tools and integrations. + +This tutorial will guide you through building and deploying an app with {% data variables.product.prodname_spark_short %} and exploring its features. + +### Prerequisites + +* A {% data variables.product.github %} account with {% data variables.copilot.copilot_pro_plus_short %}. + +## Step 1: Create your web app + +For this tutorial, we'll create a simple marketing tool app, where: +* The user enters a description of a product they want to market. +* The app generates marketing copy, and recommends a visual strategy and target audience. + +1. Navigate to https://github.com/spark. +1. In the input field, enter a description of your app. For example: + + ```text copy + Build an app called "AI-Powered Marketing Assistant." + + The app should allow users to input a brief description of a product or service. When the user submits their brief, send this information to a generative AI model with a prompt that asks the AI to return the following: + - Persuasive and engaging marketing copy for the product or service. + - A visual strategy for how to present the product/service (e.g., suggested imagery, colors, design motifs, or mood). + - A recommendation for the ideal target audience. + The app should display these three elements clearly and in an organized manner. The app should look modern, fresh and engaging. + ``` + + > [!TIP] + > * Be specific, and provide as many details as possible for the best results. You can [{% data variables.copilot.copilot_chat_short %}](https://github.com/copilot) to refine or suggest improvements to your initial prompt. + > * Alternatively, drop a markdown document into the input field to provide {% data variables.product.prodname_spark_short %} with more context on what you're hoping to build. + +1. Optionally, upload an image to provide {% data variables.product.prodname_spark_short %} with a visual reference for your app. Mocks, sketches, or screenshots all work to provide {% data variables.product.prodname_spark_short %} with an idea of what you want to build. +1. Click **{% octicon "paper-airplane" aria-label="Submit prompt" %}** to build your app. + + > [!NOTE] + > {% data variables.product.prodname_spark_short %} will always generate a Typescript and React app. + +## Step 2: Refine and expand your app + +Once {% data variables.product.prodname_spark_short %} is done generating your app, you can test it out in the live preview window. From here, you can iterate on and expand your app using natural language, visual editing controls, or code. + +1. To make changes to your app using **natural language**, under the "Iterate" tab in the left sidebar, enter your instructions in the main input field, then submit. +1. Optionally, click one of the "Suggestions" directly above the input field in the "Iterate" tab to develop your app. +1. {% data variables.product.prodname_spark_short %} automatically alerts you to detected errors. To fix the errors, click **Fix All** above the input field in the "Iterate" tab. +1. Optionally, click **{% octicon "code" aria-hidden="true" aria-label="code" %} Code** to view and edit the underlying code. The code editing panel has {% data variables.product.prodname_copilot_short %} code completion built in. +1. To make targeted changes to a specific element of your app click the **target icon** in the top right corner then hover over and select an element in the live preview pane. + +## Step 3: Customize the styling of your app + +Next, let's change the styling of your app using {% data variables.product.prodname_spark_short %}'s built-in tools. Alternatively, you can edit the code directly. + +1. Change your app's overall appearance: + * Click the **Theme** tab to adjust typography, colors, border radius, spacing, and other visual elements. + * Choose from pre-generated themes to easily update the overall style your app. +1. To target visual edits at a specific component, click the **target icon**, then select an element of the app in the preview pane. Styling controls related to that specific element will show up in the left sidebar. +1. Optionally, edit styles in code: + * Click **{% octicon "code" aria-label="Code" %}** to open the code editor. + * Modify CSS, Tailwind CSS, or custom variables for fine-grained control (e.g., padding, spacing, fonts, colors). + + > [!TIP] + > You can import custom fonts (like Google Fonts) or add advanced styles directly in the Spark code editor. + > Ask [{% data variables.copilot.copilot_chat_short %}](https://github.com/copilot) for step-by-step guidance if you're not familiar with styling syntax. + +1. Click the **Assets** tab to upload assets you want to surface in your app. + * Add images, logos, videos, documents or other assets to personalize your app. + * Once uploaded, instruct {% data variables.product.prodname_spark_short %} on how you'd like to incorporate those assets into your app in the "Iterate" tab. + +## Step 4: Store and manage data + +If {% data variables.product.prodname_spark_short %} detects the need to store data in your app, it will automatically set up data storage for you using a key-value store. + +> [!NOTE] +> If you deploy your spark and make it visible to other users, the data in your app is **shared across all users** that can access your app. Make sure no sensitive data is included in your spark prior to updating visibility settings. + +For our marketing app, let's add data storage so that users can save their favorite pieces of marketing copy and easily access them again later: + +1. Use the following instruction in the "Iterate" tab to guide {% data variables.product.prodname_spark_short %}: + + ```text copy + Add a "Favorites" page where users can save and view their favorite marketing copy results. + ``` + +1. Interact with the app once it's done generating to test saving and retrieving favorites. +1. Check the "Data" tab to view and edit the stored values. +1. If you explicitly **don't** want {% data variables.product.prodname_spark_short %} to save data, ask {% data variables.product.prodname_spark_short %} to "store data locally" or "don't persist data". + +## Step 5: Refine AI capabilities + +Next, let's iterate on the AI capabilities included in our app, which are powered by {% data variables.product.prodname_github_models %}. + +{% data variables.product.prodname_spark_short %} automatically detects when AI is needed for features in your app. It will auto-generate the prompts for each AI feature, integrate with the best-fit models, and manage API integration and LLM inference on your behalf. + +1. Click the **Prompts** tab. +1. Review the prompts {% data variables.product.prodname_spark_short %} generated to power each of the AI features used in your app. + * In the case of our marketing app there are three separate prompts {% data variables.product.prodname_spark_short %} has generated for us (marketing copy generation, visual strategy recommendation, and target audience recommendation). +1. Click on each prompt to view and edit without needing to go into the code. Make adjustments to better fit your use case. +1. Test the app to see updated results. + +## Step 6: Edit and debug with code and {% data variables.product.prodname_copilot_short %} + +You can view or edit your app’s code directly in {% data variables.product.prodname_spark_short %} or via a synced {% data variables.product.github %} codespace. + +> [!NOTE] +> * {% data variables.product.prodname_spark_short %} uses an opinionated stack (**React**, **TypeScript**) for reliability. +> * For best results, you should **work within {% data variables.product.prodname_spark_short %}'s SDK** and core framework. +> * You can **add external libraries**, but compatibility isn’t guaranteed — you should test thoroughly. +> * Directly editing the React code **lets you add model context**, as long as you follow valid syntax and {% data variables.product.prodname_spark_short %}'s framework. + +1. To edit code in {% data variables.product.prodname_spark_short %}: + * Click **{% octicon "code" aria-label=“Code” %} Code**. + * Navigate the file tree and make any edits, with access to Copilot code completions in the editor. Changes are reflected instantly in the live preview window. +1. To make more advanced edits: + * In the top right corner, click **{% octicon "kebab-horizontal" aria-label="More actions" %}**, then click **{% octicon "codespaces" aria-label=“Open codespace” %} Open codespace** (a full-featured cloud IDE) to launch a codespace in a new browser tab. + * Once inside the codespace, click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %}** to open {% data variables.product.prodname_copilot_short %} to make more advanced changes. + * In the prompt box, select **Agent** mode to enable {% data variables.product.prodname_copilot_short %} to autonomously build, review, and troubleshoot your code. + * Select **Edit** mode for {% data variables.product.prodname_copilot_short %} to review your app's code and suggest improvements and fixes. + * Choose **Ask** mode for {% data variables.product.prodname_copilot_short %} to explain and help you understand the code or any errors you see in {% data variables.product.prodname_spark_short %}. + * Changes you make in the codespace are automatically synced to {% data variables.product.prodname_spark_short %}. + +## Step 7: Deploy and share your app + +{% data variables.product.prodname_spark_short %} comes with a fully integrated runtime environment that allows you to deploy your app in one click. + +> [!NOTE] +> If you make your spark accessible to all {% data variables.product.github %} users, all users will be able to access and edit the data stored in your spark. Make sure to delete any private or sensitive data from your app prior to making it visible to other users. + +1. In the top right corner, click **Publish**. +1. By default, your spark will be private and only accessible to you. Under "Visibility", choose whether you want your spark to remain private, or make it available to all {% data variables.product.github %} users. + + ![Screenshot of the {% data variables.product.prodname_spark %} publication menu. The "All {% data variables.product.github %} users" visibility option is outlined in orange.](/assets/images/help/copilot/spark-github-user-visibility.png) + +1. Click **Visit site** to be taken to your live, deployed app. Copy your site's URL to share with others. + > [!NOTE] + > When you publish your app, {% data variables.product.prodname_spark_short %} automatically includes cloud-based storage and LLM inference for your application to use as part of the integrated runtime. + > + > The URL for your spark is generated based on the name of your spark. You can edit the name of your app and {% data variables.product.prodname_spark_short %} will automatically manage re-routing of old URLs to your latest URL. + +## Step 8: Invite collaborators with a repository + +Now that you have a functional, deployed app, you can continue to build and collaborate on your app in the same way you would with any other {% data variables.product.github %} project, by creating and linking a {% data variables.product.github %} repository to your spark. + +1. In the top right corner, click **{% octicon "kebab-horizontal" aria-label="More actions" %}**, then click **{% octicon "repo-push" aria-hidden="true" aria-label="repo-push" %} Create repository**. +1. In dialog box that opens, click **Create**. + +A new, private repository is created under your personal account on {% data variables.product.github %}, with the name of the repository based on the name of your spark. + +Any changes made to your spark prior to repository creation will be added to your repository so you have a full record of all changes and commits made to your spark since its creation. + +There's a two-way sync between your spark and the repository, so changes made in either {% data variables.product.prodname_spark_short %} or the main branch of your repository are automatically reflected in both places. + +You can also create issues in your repository and assign them to {% data variables.copilot.copilot_coding_agent %} so it can draft pull requests for fixes and improvements. + +## Next steps + +Explore more ideas you can build with {% data variables.product.prodname_spark_short %}: +* **Prototype new ideas quickly**: if you have a specific idea for a feature or app, upload a mockup, sketch, screenshot, or even paste a markdown documentation into {% data variables.product.prodname_spark_short %} and ask {% data variables.product.prodname_spark_short %} to build out your idea. +* **Build internal tools for yourself and your team**: If you have a common workflow or process that currently sits in a document or spreadsheet, explain your workflow or process to {% data variables.product.prodname_spark_short %} and {% data variables.product.prodname_spark_short %} can turn it into an interactive web app. + +## Further reading + +* [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-spark) +* [AUTOTITLE](/copilot/concepts/copilot-billing/about-billing-for-github-spark) +* [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-pre-release-license-terms) diff --git a/content/copilot/tutorials/building-your-first-app-in-minutes-with-github-spark.md b/content/copilot/tutorials/building-your-first-app-in-minutes-with-github-spark.md new file mode 100644 index 000000000000..53c01ff225a7 --- /dev/null +++ b/content/copilot/tutorials/building-your-first-app-in-minutes-with-github-spark.md @@ -0,0 +1,79 @@ +--- +title: Building your first app in minutes with GitHub Spark +shortTitle: Easy apps with Spark +intro: "Learn how to use {% data variables.product.prodname_spark %} to quickly create and deploy an app without writing any code." +allowTitleToDifferFromFilename: true +versions: + feature: spark +product: 'Anyone with a {% data variables.copilot.copilot_pro_plus_short %} license can use {% data variables.product.prodname_spark_short %}.' +--- + +Have you ever had a great idea for an app, but you didn't have the tools to build it? With the help of AI, you can now bring your app ideas to life in minutes using only natural language. In this article, we'll use {% data variables.product.prodname_spark %} to build, improve, and share a word search app without writing a single line of code ourselves. + +> [!NOTE] +> {% data reusables.spark.preview-note-spark %} + +## Creating a prototype of your app + +Let's start by generating an initial, basic version of our app that we can build on later. + +1. Navigate to https://github.com/spark. +1. Send the following prompt to generate the first iteration of your app: + + ```text copy + Please create a word search game. The game should take in a set of words from the user, then create a word search puzzle containing those words, as well as a word bank listing the words. Words in the puzzle can be horizontal, vertical, diagonal, forwards, and backwards, and are "found" when the user clicks and drags their mouse across them. Once all words are found, give the user the option to create a new puzzle. + ``` + +1. Watch as {% data variables.product.prodname_spark_short %} builds your app in real time! You'll know the app is done generating when the preview appears. +1. To test your app, create and solve a puzzle using the preview. + +## Improving your app + +Just like that, we have a working app! However, it still needs some tweaks. Let's give {% data variables.product.prodname_spark_short %} some additional prompts to polish our project. + +1. At the left side of the page, in the **Iterate** tab, send the following prompt: + + ```text copy + Please add a leaderboard and a timer to the game. The timer should start when the user generates a new puzzle, then stop when all words are found. The user should then be able to enter their name, and their name, time, and the number of words in their puzzle should be displayed on the leaderboard. The leaderboard should be sortable in ascending and descending order by each of the three categories. + ``` + +1. Once the app is updated, create and solve another puzzle to see the new features in action. +1. Get creative and make your own improvements to the app! If you're feeling stuck, pick one of the suggestions {% data variables.product.prodname_spark_short %} provides above the prompt text box. You can also make changes using the visual editing controls in the "Theme", "Data", and "Prompts" tabs, without ever having to touch code. + +## Debugging your app + +While you're building your app, you may encounter some errors. Often, {% data variables.product.prodname_spark_short %} will identify these issues and list them in an "Errors" pop up above the prompt text box. To fix the errors, click **Fix all**. + +![Screenshot of errors identified by {% data variables.product.prodname_spark %}. The "Fix all" button is outlined in orange.](/assets/images/help/copilot/spark-fix-all-errors.png) + +If you find an error that {% data variables.product.prodname_spark_short %} itself didn't flag, write a prompt to fix it. For best results, provide a detailed description of the error, as well as the ideal fixed state. For example, if you notice that adding words over a certain number of characters causes the puzzle to render incorrectly, send the following prompt: + +```text copy +Please prevent users from entering words longer than the number of rows or columns in the puzzle. Additionally, add an option to change the size of a puzzle. If the user tries to enter a word that's longer than the current size of the puzzle, display an error message telling them that provided words must be less than or equal to the size of the puzzle. +``` + +## Sharing your app + +Now that you're happy with your app, let's deploy it so you can share it with others. + +> [!NOTE] +> If you make your spark accessible to all {% data variables.product.github %} users, all users will be able to access and edit the data stored in your spark. Make sure to delete any private or sensitive data from your app prior to making it visible to other users. + +1. In the top-right corner of the page, click **Publish**. +By default, your spark is deployed as private and only accessible to you. To let other {% data variables.product.github %} users access your app, in the **Visibility** section of the publication dropdown, choose {% octicon "id-badge" aria-hidden="true" aria-label="id-badge" %} **All {% data variables.product.github %} users**. This allows anyone with a {% data variables.product.github %} account to access your spark. + + ![Screenshot of the {% data variables.product.prodname_spark %} publication menu. The "All {% data variables.product.github %} users" visibility option is outlined in orange.](/assets/images/help/copilot/spark-github-user-visibility.png) + +1. Click **View site** {% octicon "link-external" aria-hidden="true" aria-label="link-external" %} to see your deployed app, then copy and share your app's URL. + +## Next steps + +We just created a word search app, but {% data variables.product.prodname_spark_short %} can make all kinds of web apps! Try [creating a new app](https://github.com/spark) on your own. If you need some inspiration, here are a few ideas to get you started: + +* Try building a **news aggregator app** or an **intelligent recipe generator**. +* Build a **budget tracker** that lets you set a budget, takes in a list of expenses, and displays your total remaining budget. You can give each expense a category and date, then sort the expenses by the many different categories. + +## Further reading + +* [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-spark) +* [AUTOTITLE](/copilot/concepts/copilot-billing/about-billing-for-github-spark) diff --git a/content/copilot/tutorials/index.md b/content/copilot/tutorials/index.md index 28043d1aa241..d502aeadf89e 100644 --- a/content/copilot/tutorials/index.md +++ b/content/copilot/tutorials/index.md @@ -18,6 +18,8 @@ children: - /writing-tests-with-github-copilot - /refactoring-code-with-github-copilot - /learning-a-new-programming-language-with-github-copilot + - /building-your-first-app-in-minutes-with-github-spark + - /building-ai-app-prototypes - /modernizing-legacy-code-with-github-copilot - /using-copilot-to-migrate-a-project - /upgrading-projects-with-github-copilot diff --git a/content/rest/index.md b/content/rest/index.md index 0b236783278c..f1ab02711330 100644 --- a/content/rest/index.md +++ b/content/rest/index.md @@ -79,7 +79,7 @@ children: - /packages - /pages - /private-registries - - /projects + - /projects-classic - /pulls - /rate-limit - /reactions diff --git a/content/rest/projects/cards.md b/content/rest/projects-classic/cards.md similarity index 80% rename from content/rest/projects/cards.md rename to content/rest/projects-classic/cards.md index 99f016bccc2e..5d1e60c7c168 100644 --- a/content/rest/projects/cards.md +++ b/content/rest/projects-classic/cards.md @@ -12,10 +12,10 @@ versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 topics: - API autogenerated: rest +redirect_from: + - /rest/projects/cards + - /v3/projects/cards + - /rest/reference/projects/cards --- -{% data reusables.projects.projects-api %} - -{% data reusables.user-settings.classic-projects-api-classic-pat-only %} - diff --git a/content/rest/projects/collaborators.md b/content/rest/projects-classic/collaborators.md similarity index 79% rename from content/rest/projects/collaborators.md rename to content/rest/projects-classic/collaborators.md index 0c0df805405e..a49e23eaa290 100644 --- a/content/rest/projects/collaborators.md +++ b/content/rest/projects-classic/collaborators.md @@ -12,10 +12,10 @@ versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 topics: - API autogenerated: rest +redirect_from: + - /rest/projects/collaborators + - /v3/projects/collaborators + - /rest/reference/projects/collaborators --- -{% data reusables.projects.projects-api %} - -{% data reusables.user-settings.classic-projects-api-classic-pat-only %} - diff --git a/content/rest/projects/columns.md b/content/rest/projects-classic/columns.md similarity index 80% rename from content/rest/projects/columns.md rename to content/rest/projects-classic/columns.md index 295f2c715529..8b8c828001ec 100644 --- a/content/rest/projects/columns.md +++ b/content/rest/projects-classic/columns.md @@ -12,10 +12,10 @@ versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 topics: - API autogenerated: rest +redirect_from: + - /rest/projects/columns + - /v3/projects/columns + - /rest/reference/projects/columns --- -{% data reusables.projects.projects-api %} - -{% data reusables.user-settings.classic-projects-api-classic-pat-only %} - diff --git a/content/rest/projects/index.md b/content/rest/projects-classic/index.md similarity index 89% rename from content/rest/projects/index.md rename to content/rest/projects-classic/index.md index 8a4f6ee48cf0..883e6b85813e 100644 --- a/content/rest/projects/index.md +++ b/content/rest/projects-classic/index.md @@ -5,21 +5,19 @@ intro: 'Use the REST API to create, list, update, delete and customize {% data v redirect_from: - /v3/projects - /rest/reference/projects -versions: - fpt: '*' - ghes: '*' - ghec: '*' + - /rest/projects topics: - API +autogenerated: rest allowTitleToDifferFromFilename: true children: - - /projects - /cards - /collaborators - /columns -autogenerated: rest + - /projects +versions: + fpt: '*' + ghec: '*' + ghes: '*' --- - - - diff --git a/content/rest/projects/projects.md b/content/rest/projects-classic/projects.md similarity index 80% rename from content/rest/projects/projects.md rename to content/rest/projects-classic/projects.md index c4f5c2d80094..735d4359a91c 100644 --- a/content/rest/projects/projects.md +++ b/content/rest/projects-classic/projects.md @@ -12,10 +12,10 @@ versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 topics: - API autogenerated: rest +redirect_from: + - /rest/projects/projects + - /v3/projects/projects + - /rest/reference/projects/projects --- -{% data reusables.projects.projects-api %} - -{% data reusables.user-settings.classic-projects-api-classic-pat-only %} - diff --git a/data/features/horizontal-nav.yml b/data/features/horizontal-nav.yml index 6a1047331e0e..e10f47dd42cb 100644 --- a/data/features/horizontal-nav.yml +++ b/data/features/horizontal-nav.yml @@ -1,5 +1,6 @@ # Reference: #17228 # Move Enterprise navigation from left sidebar to top of page versions: + fpt: '*' ghec: '*' ghes: '>3.16' diff --git a/data/features/spark.yml b/data/features/spark.yml new file mode 100644 index 000000000000..f6715c0d95ba --- /dev/null +++ b/data/features/spark.yml @@ -0,0 +1,5 @@ +# Reference: #17636 +# Spark (No-code app builder, public preview) +versions: + fpt: '*' + ghec: '*' diff --git a/data/reusables/actions/about-artifact-attestations.md b/data/reusables/actions/about-artifact-attestations.md index ab2e90fa79c9..4280121a911a 100644 --- a/data/reusables/actions/about-artifact-attestations.md +++ b/data/reusables/actions/about-artifact-attestations.md @@ -2,8 +2,8 @@ Artifact attestations enable you to create unfalsifiable provenance and integrit When you generate artifact attestations with your software, you create cryptographically signed claims that establish your build's provenance and include the following information: -* A link to the workflow associated with the artifact. -* The repository, organization, environment, commit SHA, and triggering event for the artifact. +* A link to the workflow associated with the artifact +* The repository, organization, environment, commit SHA, and triggering event for the artifact * Other information from the OIDC token used to establish provenance. For more information, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). You can also generate artifact attestations that include an associated software bill of materials (SBOM). Associating your builds with a list of the open source dependencies used in them provides transparency and enables consumers to comply with data protection standards. diff --git a/data/reusables/copilot/differences-cfi-cfb-table.md b/data/reusables/copilot/differences-cfi-cfb-table.md index 169ce2a53b8b..99d7628ccd87 100644 --- a/data/reusables/copilot/differences-cfi-cfb-table.md +++ b/data/reusables/copilot/differences-cfi-cfb-table.md @@ -81,6 +81,7 @@ | Content exclusion | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | | {% data variables.product.prodname_copilot_short %} knowledge bases |{% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | | {% data variables.copilot.copilot_cli_short %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.product.prodname_spark %} ({% data variables.release-phases.public_preview %}) | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% endrowheaders %} diff --git a/data/reusables/copilot/repository-custom-instructions-support.md b/data/reusables/copilot/repository-custom-instructions-support.md index b606f8613eba..d4d79a9b4069 100644 --- a/data/reusables/copilot/repository-custom-instructions-support.md +++ b/data/reusables/copilot/repository-custom-instructions-support.md @@ -1,2 +1,5 @@ Repository custom instructions are currently supported for: -* **{% data variables.copilot.copilot_chat_short %}** in {% data variables.product.prodname_vs %}, {% data variables.product.prodname_vscode_shortname %}, JetBrains IDEs, Xcode, and on the {% data variables.product.github %} website +* **{% data variables.copilot.copilot_chat_short %}** in {% data variables.product.prodname_vscode_shortname %} +* **{% data variables.copilot.copilot_coding_agent %}** +* **{% data variables.copilot.copilot_chat_short %}** in {% data variables.product.prodname_vs %}, JetBrains IDEs, Xcode, and on the {% data variables.product.github %} website (`copilot-instructions.md` file only) +* **{% data variables.copilot.copilot_code-review_short %}** (`copilot-instructions.md` file only) diff --git a/data/reusables/copilot/sku-isolation.md b/data/reusables/copilot/sku-isolation.md index 968ed88e90fa..9c7c196a1310 100644 --- a/data/reusables/copilot/sku-isolation.md +++ b/data/reusables/copilot/sku-isolation.md @@ -1,6 +1,6 @@ ## About {% data variables.copilot.copilot_sku_isolation %} -As an {% ifversion ghec %}enterprise or {% endif %}organization owner, you can use your network firewall to explicitly allow access to {% data variables.copilot.copilot_for_business %}{% ifversion ghec %} or {% data variables.copilot.copilot_enterprise %}, or both{% endif %}, and/or block access to {% data variables.copilot.copilot_pro %} or {% data variables.copilot.copilot_free %}. This allows you to control which {% data variables.product.prodname_copilot %} plans your members can use within your network. +As an enterprise or organization owner, you can use your network firewall to explicitly allow access to {% data variables.copilot.copilot_for_business %}, {% data variables.copilot.copilot_enterprise %}, or both, and/or block access to {% data variables.copilot.copilot_pro %} or {% data variables.copilot.copilot_free %}. This allows you to control which {% data variables.product.prodname_copilot %} plans your members can use within your network. Configuring {% data variables.copilot.copilot_sku_isolation %} will affect the following {% data variables.product.prodname_copilot_short %} features: @@ -16,12 +16,11 @@ Configuring {% data variables.copilot.copilot_sku_isolation %} will affect the f You should ensure that your firewall allows access to all of the hostnames listed in [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot). -## Configuring {% data variables.copilot.copilot_sku_isolation %} for your {% ifversion ghec %}enterprise or {% endif %}organization +## Configuring {% data variables.copilot.copilot_sku_isolation %} for your enterprise or organization -{% ifversion ghec %}Enterprise or organization {% else %}Organization {% endif %}owners can add the endpoints for {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %}{% ifversion ghec %}, or both,{% endif %} to their allow-list. This will ensure that members can only access {% data variables.product.prodname_copilot_short %} through the allowed endpoint. +Enterprise or organization owners can add the endpoints for {% data variables.copilot.copilot_business_short %}, {% data variables.copilot.copilot_enterprise_short %}, or both to their allow-list. This will ensure that members can only access {% data variables.product.prodname_copilot_short %} through the allowed endpoint. -{% ifversion ghec %} -> [!NOTE] If your enterprise account includes both {% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} plans, make sure both endpoints are added to your allow-list.{% endif %} +> [!NOTE] If your enterprise account includes both {% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} plans, make sure both endpoints are added to your allow-list. 1. Ensure your members have updated to at least the minimum version of their {% data variables.product.prodname_copilot_short %} client listed below. * For {% data variables.product.prodname_vscode %}, use {% data variables.copilot.copilot_chat_short %} version 0.17 or later. diff --git a/data/reusables/copilot/spark-business-intro.md b/data/reusables/copilot/spark-business-intro.md new file mode 100644 index 000000000000..ddfd5aec3360 --- /dev/null +++ b/data/reusables/copilot/spark-business-intro.md @@ -0,0 +1 @@ +{% data variables.product.prodname_spark %} allows users to build applications using natural-language prompts, then share the apps with teammates or deploy them to production. diff --git a/data/reusables/enterprise-accounts/access-enterprise.md b/data/reusables/enterprise-accounts/access-enterprise.md index 87b62ca99bda..37ceebd5637b 100644 --- a/data/reusables/enterprise-accounts/access-enterprise.md +++ b/data/reusables/enterprise-accounts/access-enterprise.md @@ -1,4 +1,4 @@ -{%- ifversion ghec %} +{%- ifversion fpt or ghec %} 1. In the top-right corner of {% data variables.product.prodname_dotcom %}, click your profile picture. 1. Depending on your environment, click **Your enterprise**, or click **Your enterprises** then click the enterprise you want to view. {%- elsif ghes %} diff --git a/data/reusables/rai/spark-preview-note.md b/data/reusables/rai/spark-preview-note.md new file mode 100644 index 000000000000..fb12c55f97de --- /dev/null +++ b/data/reusables/rai/spark-preview-note.md @@ -0,0 +1,2 @@ +> [!NOTE] +> {% data variables.product.prodname_spark %} is in public preview and subject to change. diff --git a/data/reusables/spark/preview-note-spark.md b/data/reusables/spark/preview-note-spark.md new file mode 100644 index 000000000000..56f703614d73 --- /dev/null +++ b/data/reusables/spark/preview-note-spark.md @@ -0,0 +1 @@ +{% data variables.product.prodname_spark %} is in public preview and subject to change. diff --git a/data/variables/product.yml b/data/variables/product.yml index 495c2cab8b03..dcde2a2ab085 100644 --- a/data/variables/product.yml +++ b/data/variables/product.yml @@ -301,6 +301,10 @@ prodname_arctic_vault: 'Arctic Code Vault' prodname_copilot: 'GitHub Copilot' prodname_copilot_short: 'Copilot' +# GitHub Spark +prodname_spark: 'GitHub Spark' +prodname_spark_short: 'Spark' + # Windows prodname_windows_terminal: 'Windows Terminal' diff --git a/package-lock.json b/package-lock.json index 6737dcdf26ed..9f225c4351d3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -137,7 +137,7 @@ "commander": "^14.0.0", "cross-env": "^7.0.3", "csp-parse": "0.0.2", - "csv-parse": "5.5.6", + "csv-parse": "6.1.0", "eslint": "^8.57.1", "eslint-config-prettier": "^10.0.3", "eslint-import-resolver-typescript": "^4.4.2", @@ -6874,10 +6874,11 @@ "license": "MIT" }, "node_modules/csv-parse": { - "version": "5.5.6", - "resolved": "https://registry.npmjs.org/csv-parse/-/csv-parse-5.5.6.tgz", - "integrity": "sha512-uNpm30m/AGSkLxxy7d9yRXpJQFrZzVWLFBkS+6ngPcZkw/5k3L/jjFuj7tVnEpRn+QgmiXr21nDlhCiUK4ij2A==", - "dev": true + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/csv-parse/-/csv-parse-6.1.0.tgz", + "integrity": "sha512-CEE+jwpgLn+MmtCpVcPtiCZpVtB6Z2OKPTr34pycYYoL7sxdOkXDdQ4lRiw6ioC0q6BLqhc6cKweCVvral8yhw==", + "dev": true, + "license": "MIT" }, "node_modules/cuss": { "version": "2.2.0", diff --git a/package.json b/package.json index 81de7a9faa53..ef59340544de 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,7 @@ }, "exports": "./src/frame/server.ts", "scripts": { + "add-content-type": "tsx src/content-render/scripts/add-content-type.ts", "ai-edit": "tsx src/ai-editors/scripts/ai-edit.ts", "all-documents": "tsx src/content-render/scripts/all-documents/cli.ts", "analyze-text": "tsx src/search/scripts/analyze-text.ts", @@ -374,7 +375,7 @@ "commander": "^14.0.0", "cross-env": "^7.0.3", "csp-parse": "0.0.2", - "csv-parse": "5.5.6", + "csv-parse": "6.1.0", "eslint": "^8.57.1", "eslint-config-prettier": "^10.0.3", "eslint-import-resolver-typescript": "^4.4.2", diff --git a/src/content-render/scripts/add-content-type.ts b/src/content-render/scripts/add-content-type.ts new file mode 100644 index 000000000000..f74d5e2177c3 --- /dev/null +++ b/src/content-render/scripts/add-content-type.ts @@ -0,0 +1,186 @@ +// This script auto-populates the `contentType` frontmatter property based on +// the directory location of the content file. +// Run with: +// npm run-script -- add-content-type --help + +import fs from 'fs' +import path from 'path' +import { program } from 'commander' +import frontmatter from '@/frame/lib/read-frontmatter' +import walkFiles from '@/workflows/walk-files' +import { contentTypesEnum } from '#src/frame/lib/frontmatter.js' +import type { MarkdownFrontmatter } from '@/types' + +const RESPONSIBLE_USE_STRING = 'responsible-use' +const LANDING_TYPE = 'landing' +const RAI_TYPE = 'rai' +const OTHER_TYPE = 'other' + +interface ScriptOptions { + dryRun?: boolean + paths?: string[] + removeType?: boolean + verbose?: boolean +} + +program + .description('Auto-populate the contentType frontmatter property based on file location') + .option( + '-p, --paths [paths...]', + 'One or more specific paths to process (e.g., copilot or content/copilot/how-tos/file.md)', + ) + .option('-r, --remove-type', `Remove the legacy 'type' frontmatter property if present`) + .option('-d, --dry-run', 'Preview changes without modifying files') + .option('-v, --verbose', 'Show detailed output of changes made') + .addHelpText( + 'after', + ` +Possible contentType values: + ${contentTypesEnum.join(', ')} + +Examples: + npm run-script -- add-content-type // runs on all content files, does not remove legacy 'type' prop + npm run-script -- add-content-type --paths copilot actions --remove-type --dry-run + npm run-script -- add-content-type --paths content/copilot/how-tos + npm run-script -- add-content-type --verbose`, + ) + .parse(process.argv) + +const options: ScriptOptions = program.opts() + +const contentDir = path.join(process.cwd(), 'content') + +async function main() { + const filesToProcess: string[] = walkFiles(contentDir, ['.md']).filter((file: string) => { + if (file.endsWith('README.md')) return false + if (file.includes('early-access')) return false + if (!options.paths) return true + return options.paths.some((p: string) => { + // Allow either a full content path like "content/foo/bar.md" + // or a top-level directory name like "copilot" + if (!p.startsWith('content')) { + p = path.join('content', p) + } + if (!fs.existsSync(p)) { + console.error(`${p} not found`) + process.exit(1) + } + if (path.relative(process.cwd(), file).startsWith(p)) return true + }) + }) + + let processedCount = 0 + let updatedCount = 0 + + for (const filePath of filesToProcess) { + try { + const result = processFile(filePath, options) + if (result.processed) processedCount++ + if (result.updated) updatedCount++ + } catch (error) { + console.error( + `Error processing ${filePath}:`, + error instanceof Error ? error.message : String(error), + ) + } + } + + console.log(`\nUpdated ${updatedCount} files out of ${processedCount}`) +} + +function processFile(filePath: string, options: ScriptOptions) { + const fileContent = fs.readFileSync(filePath, 'utf8') + const relativePath = path.relative(contentDir, filePath) + + const { data, content } = frontmatter(fileContent) as unknown as { + data: MarkdownFrontmatter & { contentType?: string } + content: string + } + + if (!data) return { processed: false, updated: false } + + // Remove the legacy type property if option is passed + const removeLegacyType = Boolean(options.removeType && data.type) + + // Skip if contentType already exists and we're not removing legacy type + if (data.contentType && !removeLegacyType) { + console.log(`contentType already set on ${relativePath}`) + return { processed: true, updated: false } + } + + const newContentType = data.contentType || determineContentType(relativePath, data.type || '') + + if (options.dryRun) { + console.log(`\n${relativePath}`) + if (!data.contentType) { + console.log(` ✅ Would set contentType: "${newContentType}"`) + } + if (removeLegacyType) { + console.log(` ✂️ Would remove legacy type: "${data.type}"`) + } + return { processed: true, updated: false } + } + + // Set the contentType property if it doesn't exist + if (!data.contentType) { + data.contentType = newContentType + } + + let legacyTypeValue + if (removeLegacyType) { + legacyTypeValue = data.type + delete data.type + } + + // Write the file back + fs.writeFileSync(filePath, frontmatter.stringify(content, data, { lineWidth: -1 } as any)) + + if (options.verbose) { + console.log(`\n${relativePath}`) + console.log(` ✅ Set contentType: "${newContentType}"`) + if (removeLegacyType) { + console.log(` ✂️ Removed legacy type: "${legacyTypeValue}"`) + } + } + + return { processed: true, updated: true } +} + +function determineContentType(relativePath: string, legacyType: string): string { + // The split path array will be structured like: + // [ 'copilot', 'how-tos', 'troubleshoot', 'index.md' ] + // where the content type we want is in slot 1. + const pathSegments = relativePath.split(path.sep) + + const topLevelDirectory = pathSegments[0] + const derivedContentType = pathSegments[1] + + // There is only one content/index.md, and it's the homepage. + if (topLevelDirectory === 'index.md') return 'homepage' + + // SPECIAL HANDLING FOR RAI + // If a legacy type includes 'rai', use it for the contentType. + // If a directory name includes a responsible-use string, assume the 'rai' type. + if (legacyType === 'rai' || derivedContentType.includes(RESPONSIBLE_USE_STRING)) { + return RAI_TYPE + } + + // When the content directory matches any of the allowed + // content type values (such as 'get-started', + // 'concepts', 'how-tos', 'reference', and 'tutorials'), + // immediately return it. We're satisfied. + if (contentTypesEnum.includes(derivedContentType)) { + return derivedContentType + } + + // There is only one content//index.md file per doc set. + // This index.md is always a landing page. + if (derivedContentType === 'index.md') { + return LANDING_TYPE + } + + // Classify anything else as 'other'. + return OTHER_TYPE +} + +main().catch(console.error) diff --git a/src/fixtures/fixtures/rest-redirects.json b/src/fixtures/fixtures/rest-redirects.json index 5a364f6e338d..b9eb9cb5f4ca 100644 --- a/src/fixtures/fixtures/rest-redirects.json +++ b/src/fixtures/fixtures/rest-redirects.json @@ -460,10 +460,10 @@ "/v3/orgs/outside_collaborators": "/en/rest/orgs/outside-collaborators", "/v3/orgs/pre_receive_hooks": "/en/enterprise-server/rest/enterprise-admin/org-pre-receive-hooks", "/v3/orgs/teams": "/en/rest/teams/teams", - "/v3/projects/cards": "/en/rest/projects/cards", - "/v3/projects/collaborators": "/en/rest/projects/collaborators", - "/v3/projects/columns": "/en/rest/projects/columns", - "/v3/projects": "/en/rest/projects", + "/v3/projects/cards": "/en/rest/projects-classic/cards", + "/v3/projects/collaborators": "/en/rest/projects-classic/collaborators", + "/v3/projects/columns": "/en/rest/projects-classic/columns", + "/v3/projects": "/en/rest/projects-classic", "/v3/pulls/comments": "/en/rest/pulls/comments", "/v3/pulls": "/en/rest/pulls", "/v3/pulls/review_requests": "/en/rest/pulls/review-requests", diff --git a/src/frame/lib/frontmatter.js b/src/frame/lib/frontmatter.js index 9d12b7049709..097e09fe3ac7 100644 --- a/src/frame/lib/frontmatter.js +++ b/src/frame/lib/frontmatter.js @@ -17,8 +17,24 @@ const layoutNames = [ false, ] +// DEPRECATED: Use 'contentType' instead of 'type' for new content. +// 'type' exists on ~40% of files but is used only for internal analytics. +// Migration tool: src/content-render/scripts/add-content-type.ts const guideTypes = ['overview', 'quick_start', 'tutorial', 'how_to', 'reference', 'rai'] +// As of July 2025, use 'contentType' rather than 'type'. +export const contentTypesEnum = [ + 'get-started', + 'concepts', + 'how-tos', + 'reference', + 'tutorials', + 'homepage', // Only applies to the sole 'content/index.md' file (the homepage). + 'landing', // Only applies to 'content//index.md' files (product landings). + 'rai', // Only applies to files that live in directories with 'responsible-use' in the name. + 'other', // Everything else. +] + export const schema = { type: 'object', required: ['title', 'versions'], @@ -150,10 +166,18 @@ export const schema = { prefix: { type: 'string' }, }, }, + // DEPRECATED: Use 'contentType' instead of 'type' for new content. + // 'type' exists on ~40% of files but is used only for internal analytics. + // Migration tool: src/content-render/scripts/add-content-type.ts type: { type: 'string', enum: guideTypes, }, + // As of July 2025, use 'contentType' rather than 'type'. + contentType: { + type: 'string', + enum: contentTypesEnum, + }, topics: { type: 'array', }, diff --git a/src/frame/lib/page.ts b/src/frame/lib/page.ts index 453029778600..5da0d76918a6 100644 --- a/src/frame/lib/page.ts +++ b/src/frame/lib/page.ts @@ -187,8 +187,12 @@ class Page { constructor(opts: PageReadResult) { if (opts.frontmatterErrors && opts.frontmatterErrors.length) { + console.error( + `${opts.frontmatterErrors.length} frontmatter errors trying to load ${opts.fullPath}:`, + ) + console.error(opts.frontmatterErrors) throw new FrontmatterErrorsError( - `${opts.frontmatterErrors.length} frontmatter errors trying to load ${opts.fullPath}`, + `${opts.frontmatterErrors.length} frontmatter errors in ${opts.fullPath}`, opts.frontmatterErrors, ) } 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 3e1e50f6b270..4287ba5283ce 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 @@ -1989,6 +1989,24 @@ "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", "permissions": [ + { + "category": "projects-classic", + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "additional-permissions": false, + "access": "write" + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", @@ -2006,6 +2024,177 @@ "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "additional-permissions": true, "access": "admin" + }, + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "additional-permissions": true, + "access": "write" } ] }, @@ -6243,114 +6432,6 @@ "title": "Metadata", "displayTitle": "Repository permissions for \"Metadata\"", "permissions": [ - { - "category": "actions", - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "codespaces", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "organization-secrets", - "verb": "put", - "requestPath": "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "codespaces", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "organization-secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "dependabot", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "dependabot", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "list-organization-repositories", @@ -6360,33 +6441,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "get-a-repository", @@ -6648,51 +6702,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "codespaces", - "slug": "add-a-selected-repository-to-a-user-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "codespaces", - "slug": "remove-a-selected-repository-from-a-user-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, { "category": "apps", "slug": "list-repositories-accessible-to-the-user-access-token", @@ -6711,33 +6720,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "activity", - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "activity", - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "activity", - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "list-repositories-for-a-user", 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 50a3549be76e..bc5a9c40f081 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 @@ -3503,6 +3503,134 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + } + ], "pulls": [ { "slug": "list-pull-requests", 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 27e220c719e4..4ceb7bef05eb 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 @@ -2509,6 +2509,28 @@ "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", "permissions": [ + { + "category": "projects-classic", + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects-classic", + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", @@ -2530,6 +2552,215 @@ "user-to-server": true, "server-to-server": true, "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true } ] }, @@ -7829,257 +8060,92 @@ "displayTitle": "Repository permissions for \"Metadata\"", "permissions": [ { - "category": "actions", - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "category": "repos", + "slug": "list-organization-repositories", + "subcategory": "repos", + "verb": "get", + "requestPath": "/orgs/{org}/repos", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "category": "repos", + "slug": "get-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "category": "collaborators", + "slug": "list-repository-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "category": "collaborators", + "slug": "check-if-a-user-is-a-repository-collaborator", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "category": "collaborators", + "slug": "get-repository-permissions-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "category": "commits", + "slug": "list-commit-comments-for-a-repository", + "subcategory": "comments", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "category": "commits", + "slug": "get-a-commit-comment", + "subcategory": "comments", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "category": "reactions", + "slug": "list-reactions-for-a-commit-comment", + "subcategory": "reactions", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true - }, - { - "category": "codespaces", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "organization-secrets", - "verb": "put", - "requestPath": "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "codespaces", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "organization-secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "dependabot", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "dependabot", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "list-organization-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/orgs/{org}/repos", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "get-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "list-repository-collaborators", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "check-if-a-user-is-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "get-repository-permissions-for-a-user", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "list-commit-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "get-a-commit-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "list-reactions-for-a-commit-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false + "additional-permissions": false }, { "category": "commits", @@ -8323,61 +8389,6 @@ "server-to-server": true, "additional-permissions": false }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "codespaces", - "slug": "add-a-selected-repository-to-a-user-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "codespaces", - "slug": "remove-a-selected-repository-from-a-user-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, { "category": "apps", "slug": "list-repositories-accessible-to-the-user-access-token", @@ -8400,39 +8411,6 @@ "server-to-server": false, "additional-permissions": false }, - { - "category": "activity", - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, { "category": "repos", "slug": "list-repositories-for-a-user", @@ -8584,6 +8562,243 @@ } ] }, + "repository_projects": { + "title": "Projects", + "displayTitle": "Repository permissions for \"Projects\"", + "permissions": [ + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects-classic", + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "pull_requests": { "title": "Pull requests", "displayTitle": "Repository permissions for \"Pull requests\"", 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 b0350ee5eb7a..84461990c29f 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 @@ -3597,6 +3597,146 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects" + }, + { + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects" + } + ], "pulls": [ { "slug": "list-pull-requests", 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 7ee4b32575e1..4f4cda3cbb22 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 @@ -4065,6 +4065,146 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects" + }, + { + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects" + } + ], "pulls": [ { "slug": "list-pull-requests", 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 0cc0d0e51906..1b72f2417b59 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 @@ -2682,6 +2682,24 @@ "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", "permissions": [ + { + "category": "projects-classic", + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "additional-permissions": false, + "access": "write" + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", @@ -2699,6 +2717,177 @@ "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "additional-permissions": true, "access": "admin" + }, + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "additional-permissions": true, + "access": "write" } ] }, @@ -7059,114 +7248,6 @@ "title": "Metadata", "displayTitle": "Repository permissions for \"Metadata\"", "permissions": [ - { - "category": "actions", - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "codespaces", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "organization-secrets", - "verb": "put", - "requestPath": "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "codespaces", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "organization-secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "dependabot", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "dependabot", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "list-organization-repositories", @@ -7176,33 +7257,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "get-a-repository", @@ -7464,51 +7518,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "codespaces", - "slug": "add-a-selected-repository-to-a-user-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "codespaces", - "slug": "remove-a-selected-repository-from-a-user-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, { "category": "apps", "slug": "list-repositories-accessible-to-the-user-access-token", @@ -7527,33 +7536,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "activity", - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "activity", - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "activity", - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "list-repositories-for-a-user", 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 0ba8b5005e80..242c55eb5839 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 @@ -3867,6 +3867,134 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + } + ], "pulls": [ { "slug": "list-pull-requests", 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 21c1983f37f0..c95311588c05 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 @@ -3514,6 +3514,28 @@ "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", "permissions": [ + { + "category": "projects-classic", + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects-classic", + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", @@ -3535,6 +3557,215 @@ "user-to-server": true, "server-to-server": true, "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true } ] }, @@ -8983,257 +9214,92 @@ "displayTitle": "Repository permissions for \"Metadata\"", "permissions": [ { - "category": "actions", - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "category": "repos", + "slug": "list-organization-repositories", + "subcategory": "repos", + "verb": "get", + "requestPath": "/orgs/{org}/repos", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "category": "repos", + "slug": "get-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "category": "collaborators", + "slug": "list-repository-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "category": "collaborators", + "slug": "check-if-a-user-is-a-repository-collaborator", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "category": "collaborators", + "slug": "get-repository-permissions-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "category": "commits", + "slug": "list-commit-comments-for-a-repository", + "subcategory": "comments", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "category": "commits", + "slug": "get-a-commit-comment", + "subcategory": "comments", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "category": "reactions", + "slug": "list-reactions-for-a-commit-comment", + "subcategory": "reactions", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true - }, - { - "category": "codespaces", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "organization-secrets", - "verb": "put", - "requestPath": "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "codespaces", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "organization-secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "dependabot", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "dependabot", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "list-organization-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/orgs/{org}/repos", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "get-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "list-repository-collaborators", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "check-if-a-user-is-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "get-repository-permissions-for-a-user", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "list-commit-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "get-a-commit-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "list-reactions-for-a-commit-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false + "additional-permissions": false }, { "category": "commits", @@ -9477,61 +9543,6 @@ "server-to-server": true, "additional-permissions": false }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "codespaces", - "slug": "add-a-selected-repository-to-a-user-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "codespaces", - "slug": "remove-a-selected-repository-from-a-user-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, { "category": "apps", "slug": "list-repositories-accessible-to-the-user-access-token", @@ -9554,39 +9565,6 @@ "server-to-server": false, "additional-permissions": false }, - { - "category": "activity", - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, { "category": "repos", "slug": "list-repositories-for-a-user", @@ -9738,6 +9716,243 @@ } ] }, + "repository_projects": { + "title": "Projects", + "displayTitle": "Repository permissions for \"Projects\"", + "permissions": [ + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects-classic", + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "pull_requests": { "title": "Pull requests", "displayTitle": "Repository permissions for \"Pull requests\"", 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 1e05bc3aa35b..f388bab6d99b 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 @@ -4015,6 +4015,146 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects" + }, + { + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects" + } + ], "pulls": [ { "slug": "list-pull-requests", 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 aedd5130fb55..93aa9ce5a801 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 @@ -4483,6 +4483,146 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects" + }, + { + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects" + } + ], "pulls": [ { "slug": "list-pull-requests", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json index 53f5ddb145d2..dd3abb0e2898 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json @@ -1359,6 +1359,24 @@ "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", "permissions": [ + { + "category": "projects-classic", + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "additional-permissions": false, + "access": "write" + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", @@ -1376,6 +1394,177 @@ "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "additional-permissions": true, "access": "admin" + }, + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "additional-permissions": true, + "access": "write" } ] }, @@ -4908,96 +5097,6 @@ "title": "Metadata", "displayTitle": "Repository permissions for \"Metadata\"", "permissions": [ - { - "category": "actions", - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "dependabot", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "dependabot", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "list-organization-repositories", @@ -5007,33 +5106,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "get-a-repository", @@ -5286,33 +5358,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "apps", "slug": "list-repositories-accessible-to-the-user-access-token", @@ -5331,33 +5376,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "activity", - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "activity", - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "activity", - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "list-repositories-for-a-user", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json index aca106a816e7..b96420e20057 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json @@ -2713,6 +2713,134 @@ "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + } + ], "pulls": [ { "slug": "list-pull-requests", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json index c29d7f15e38f..5d4fa3f85ad4 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json @@ -1747,6 +1747,28 @@ "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", "permissions": [ + { + "category": "projects-classic", + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects-classic", + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", @@ -1768,6 +1790,215 @@ "user-to-server": true, "server-to-server": true, "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true } ] }, @@ -6212,235 +6443,92 @@ "displayTitle": "Repository permissions for \"Metadata\"", "permissions": [ { - "category": "actions", - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "category": "repos", + "slug": "list-organization-repositories", + "subcategory": "repos", + "verb": "get", + "requestPath": "/orgs/{org}/repos", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "category": "repos", + "slug": "get-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "category": "collaborators", + "slug": "list-repository-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "category": "collaborators", + "slug": "check-if-a-user-is-a-repository-collaborator", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "category": "collaborators", + "slug": "get-repository-permissions-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "category": "commits", + "slug": "list-commit-comments-for-a-repository", + "subcategory": "comments", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "category": "commits", + "slug": "get-a-commit-comment", + "subcategory": "comments", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "category": "reactions", + "slug": "list-reactions-for-a-commit-comment", + "subcategory": "reactions", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true - }, - { - "category": "dependabot", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "dependabot", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "list-organization-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/orgs/{org}/repos", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "get-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "list-repository-collaborators", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "check-if-a-user-is-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "get-repository-permissions-for-a-user", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "list-commit-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "get-a-commit-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "list-reactions-for-a-commit-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false + "additional-permissions": false }, { "category": "commits", @@ -6673,39 +6761,6 @@ "server-to-server": true, "additional-permissions": false }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "apps", "slug": "list-repositories-accessible-to-the-user-access-token", @@ -6728,39 +6783,6 @@ "server-to-server": false, "additional-permissions": false }, - { - "category": "activity", - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, { "category": "repos", "slug": "list-repositories-for-a-user", @@ -6951,6 +6973,243 @@ } ] }, + "repository_projects": { + "title": "Projects", + "displayTitle": "Repository permissions for \"Projects\"", + "permissions": [ + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects-classic", + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "pull_requests": { "title": "Pull requests", "displayTitle": "Repository permissions for \"Pull requests\"", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json index d2ab0f925bac..ea1f90c74166 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json @@ -3023,6 +3023,146 @@ "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects" + }, + { + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects" + } + ], "pulls": [ { "slug": "list-pull-requests", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json index 52aa6490782b..6de1175d62e6 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json @@ -3199,6 +3199,146 @@ "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects" + }, + { + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects" + } + ], "pulls": [ { "slug": "list-pull-requests", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json index 6f010d994498..5c759e8b976d 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json @@ -1449,6 +1449,24 @@ "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", "permissions": [ + { + "category": "projects-classic", + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "additional-permissions": false, + "access": "write" + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", @@ -1466,6 +1484,177 @@ "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "additional-permissions": true, "access": "admin" + }, + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "additional-permissions": true, + "access": "write" } ] }, @@ -5016,96 +5205,6 @@ "title": "Metadata", "displayTitle": "Repository permissions for \"Metadata\"", "permissions": [ - { - "category": "actions", - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "dependabot", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "dependabot", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "list-organization-repositories", @@ -5115,33 +5214,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "get-a-repository", @@ -5394,33 +5466,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "apps", "slug": "list-repositories-accessible-to-the-user-access-token", @@ -5439,33 +5484,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "activity", - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "activity", - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "activity", - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "list-repositories-for-a-user", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json index c4ec8b575f63..d2c2234fc261 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json @@ -2781,6 +2781,134 @@ "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + } + ], "pulls": [ { "slug": "list-pull-requests", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json index f2002d79c37c..bb4ebc536f78 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json @@ -1857,6 +1857,28 @@ "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", "permissions": [ + { + "category": "projects-classic", + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects-classic", + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", @@ -1878,6 +1900,215 @@ "user-to-server": true, "server-to-server": true, "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true } ] }, @@ -6344,235 +6575,92 @@ "displayTitle": "Repository permissions for \"Metadata\"", "permissions": [ { - "category": "actions", - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "category": "repos", + "slug": "list-organization-repositories", + "subcategory": "repos", + "verb": "get", + "requestPath": "/orgs/{org}/repos", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "category": "repos", + "slug": "get-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "category": "collaborators", + "slug": "list-repository-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "category": "collaborators", + "slug": "check-if-a-user-is-a-repository-collaborator", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "category": "collaborators", + "slug": "get-repository-permissions-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "category": "commits", + "slug": "list-commit-comments-for-a-repository", + "subcategory": "comments", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "category": "commits", + "slug": "get-a-commit-comment", + "subcategory": "comments", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "category": "reactions", + "slug": "list-reactions-for-a-commit-comment", + "subcategory": "reactions", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true - }, - { - "category": "dependabot", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "dependabot", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "list-organization-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/orgs/{org}/repos", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "get-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "list-repository-collaborators", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "check-if-a-user-is-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "get-repository-permissions-for-a-user", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "list-commit-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "get-a-commit-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "list-reactions-for-a-commit-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false + "additional-permissions": false }, { "category": "commits", @@ -6805,39 +6893,6 @@ "server-to-server": true, "additional-permissions": false }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "apps", "slug": "list-repositories-accessible-to-the-user-access-token", @@ -6860,39 +6915,6 @@ "server-to-server": false, "additional-permissions": false }, - { - "category": "activity", - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, { "category": "repos", "slug": "list-repositories-for-a-user", @@ -7083,6 +7105,243 @@ } ] }, + "repository_projects": { + "title": "Projects", + "displayTitle": "Repository permissions for \"Projects\"", + "permissions": [ + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects-classic", + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "pull_requests": { "title": "Pull requests", "displayTitle": "Repository permissions for \"Pull requests\"", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json index 60a0138f0e0b..4db76d7e45a0 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json @@ -3091,6 +3091,146 @@ "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects" + }, + { + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects" + } + ], "pulls": [ { "slug": "list-pull-requests", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json index 39ddba3dbe45..5d5ca26f34be 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json @@ -3267,6 +3267,146 @@ "requestPath": "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects" + }, + { + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects" + } + ], "pulls": [ { "slug": "list-pull-requests", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json index 8e97bdbf945a..f85e3c79b49f 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json @@ -1500,6 +1500,24 @@ "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", "permissions": [ + { + "category": "projects-classic", + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "additional-permissions": false, + "access": "write" + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", @@ -1517,6 +1535,177 @@ "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "additional-permissions": true, "access": "admin" + }, + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "additional-permissions": true, + "access": "write" } ] }, @@ -5067,96 +5256,6 @@ "title": "Metadata", "displayTitle": "Repository permissions for \"Metadata\"", "permissions": [ - { - "category": "actions", - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "dependabot", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "dependabot", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "list-organization-repositories", @@ -5166,33 +5265,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "get-a-repository", @@ -5445,33 +5517,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "apps", "slug": "list-repositories-accessible-to-the-user-access-token", @@ -5490,33 +5535,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "activity", - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "activity", - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "activity", - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "list-repositories-for-a-user", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json index 1e7144222bcf..6255efe228d9 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json @@ -2813,6 +2813,134 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + } + ], "pulls": [ { "slug": "list-pull-requests", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json index fb5f110cd207..1bbc62e01ceb 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json @@ -1918,6 +1918,28 @@ "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", "permissions": [ + { + "category": "projects-classic", + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects-classic", + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", @@ -1939,6 +1961,215 @@ "user-to-server": true, "server-to-server": true, "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true } ] }, @@ -6405,235 +6636,92 @@ "displayTitle": "Repository permissions for \"Metadata\"", "permissions": [ { - "category": "actions", - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "category": "repos", + "slug": "list-organization-repositories", + "subcategory": "repos", + "verb": "get", + "requestPath": "/orgs/{org}/repos", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "category": "repos", + "slug": "get-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "category": "collaborators", + "slug": "list-repository-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "category": "collaborators", + "slug": "check-if-a-user-is-a-repository-collaborator", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "category": "collaborators", + "slug": "get-repository-permissions-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "category": "commits", + "slug": "list-commit-comments-for-a-repository", + "subcategory": "comments", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "category": "commits", + "slug": "get-a-commit-comment", + "subcategory": "comments", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "category": "reactions", + "slug": "list-reactions-for-a-commit-comment", + "subcategory": "reactions", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true - }, - { - "category": "dependabot", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "dependabot", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "list-organization-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/orgs/{org}/repos", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "get-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "list-repository-collaborators", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "check-if-a-user-is-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "get-repository-permissions-for-a-user", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "list-commit-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "get-a-commit-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "list-reactions-for-a-commit-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false + "additional-permissions": false }, { "category": "commits", @@ -6866,39 +6954,6 @@ "server-to-server": true, "additional-permissions": false }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "apps", "slug": "list-repositories-accessible-to-the-user-access-token", @@ -6921,39 +6976,6 @@ "server-to-server": false, "additional-permissions": false }, - { - "category": "activity", - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, { "category": "repos", "slug": "list-repositories-for-a-user", @@ -7144,6 +7166,243 @@ } ] }, + "repository_projects": { + "title": "Projects", + "displayTitle": "Repository permissions for \"Projects\"", + "permissions": [ + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects-classic", + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "pull_requests": { "title": "Pull requests", "displayTitle": "Repository permissions for \"Pull requests\"", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json index a2ec68e831fb..5f8b5226c514 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json @@ -3123,6 +3123,146 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects" + }, + { + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects" + } + ], "pulls": [ { "slug": "list-pull-requests", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json index 27942ef40c1b..980631161b9b 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json @@ -3299,6 +3299,146 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects" + }, + { + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects" + } + ], "pulls": [ { "slug": "list-pull-requests", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json index 8a5e1ff1e09d..bc0af8eafa2f 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json @@ -1551,6 +1551,24 @@ "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", "permissions": [ + { + "category": "projects-classic", + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "additional-permissions": false, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "additional-permissions": false, + "access": "write" + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", @@ -1568,6 +1586,177 @@ "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "additional-permissions": true, "access": "admin" + }, + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "additional-permissions": true, + "access": "admin" + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "additional-permissions": true, + "access": "read" + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "additional-permissions": true, + "access": "write" } ] }, @@ -5136,96 +5325,6 @@ "title": "Metadata", "displayTitle": "Repository permissions for \"Metadata\"", "permissions": [ - { - "category": "actions", - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "dependabot", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "dependabot", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "list-organization-repositories", @@ -5235,33 +5334,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "get-a-repository", @@ -5514,33 +5586,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "apps", "slug": "list-repositories-accessible-to-the-user-access-token", @@ -5559,33 +5604,6 @@ "additional-permissions": false, "access": "read" }, - { - "category": "activity", - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "activity", - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, - { - "category": "activity", - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "additional-permissions": true, - "access": "read" - }, { "category": "repos", "slug": "list-repositories-for-a-user", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json index 441365208389..71fea4ba50da 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json @@ -2819,6 +2819,134 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + } + ], "pulls": [ { "slug": "list-pull-requests", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json index b18d0bdc63f6..796545861df6 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json @@ -1979,6 +1979,28 @@ "title": "Projects", "displayTitle": "Organization permissions for \"Projects\"", "permissions": [ + { + "category": "projects-classic", + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects-classic", + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "teams", "slug": "add-or-update-team-project-permissions", @@ -2000,6 +2022,215 @@ "user-to-server": true, "server-to-server": true, "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true } ] }, @@ -6488,235 +6719,92 @@ "displayTitle": "Repository permissions for \"Metadata\"", "permissions": [ { - "category": "actions", - "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "put", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "category": "repos", + "slug": "list-organization-repositories", + "subcategory": "repos", + "verb": "get", + "requestPath": "/orgs/{org}/repos", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", - "subcategory": "permissions", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "category": "repos", + "slug": "get-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "put", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "category": "collaborators", + "slug": "list-repository-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", - "subcategory": "self-hosted-runner-groups", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "category": "collaborators", + "slug": "check-if-a-user-is-a-repository-collaborator", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "category": "collaborators", + "slug": "get-repository-permissions-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "category": "commits", + "slug": "list-commit-comments-for-a-repository", + "subcategory": "comments", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "add-selected-repository-to-an-organization-variable", - "subcategory": "variables", - "verb": "put", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "category": "commits", + "slug": "get-a-commit-comment", + "subcategory": "comments", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true + "additional-permissions": false }, { - "category": "actions", - "slug": "remove-selected-repository-from-an-organization-variable", - "subcategory": "variables", - "verb": "delete", - "requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "category": "reactions", + "slug": "list-reactions-for-a-commit-comment", + "subcategory": "reactions", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "access": "read", "user-to-server": true, "server-to-server": true, - "additional-permissions": true - }, - { - "category": "dependabot", - "slug": "add-selected-repository-to-an-organization-secret", - "subcategory": "secrets", - "verb": "put", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "dependabot", - "slug": "remove-selected-repository-from-an-organization-secret", - "subcategory": "secrets", - "verb": "delete", - "requestPath": "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "list-organization-repositories", - "subcategory": "repos", - "verb": "get", - "requestPath": "/orgs/{org}/repos", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository", - "subcategory": "teams", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions", - "subcategory": "teams", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "repos", - "slug": "get-a-repository", - "subcategory": "repos", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "list-repository-collaborators", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "check-if-a-user-is-a-repository-collaborator", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "collaborators", - "slug": "get-repository-permissions-for-a-user", - "subcategory": "collaborators", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "list-commit-comments-for-a-repository", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "commits", - "slug": "get-a-commit-comment", - "subcategory": "comments", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false - }, - { - "category": "reactions", - "slug": "list-reactions-for-a-commit-comment", - "subcategory": "reactions", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": false + "additional-permissions": false }, { "category": "commits", @@ -6949,39 +7037,6 @@ "server-to-server": true, "additional-permissions": false }, - { - "category": "teams", - "slug": "check-team-permissions-for-a-repository-legacy", - "subcategory": "teams", - "verb": "get", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "add-or-update-team-repository-permissions-legacy", - "subcategory": "teams", - "verb": "put", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, - { - "category": "teams", - "slug": "remove-a-repository-from-a-team-legacy", - "subcategory": "teams", - "verb": "delete", - "requestPath": "/teams/{team_id}/repos/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": true, - "additional-permissions": true - }, { "category": "apps", "slug": "list-repositories-accessible-to-the-user-access-token", @@ -7004,39 +7059,6 @@ "server-to-server": false, "additional-permissions": false }, - { - "category": "activity", - "slug": "check-if-a-repository-is-starred-by-the-authenticated-user", - "subcategory": "starring", - "verb": "get", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "star-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "put", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, - { - "category": "activity", - "slug": "unstar-a-repository-for-the-authenticated-user", - "subcategory": "starring", - "verb": "delete", - "requestPath": "/user/starred/{owner}/{repo}", - "access": "read", - "user-to-server": true, - "server-to-server": false, - "additional-permissions": true - }, { "category": "repos", "slug": "list-repositories-for-a-user", @@ -7227,6 +7249,243 @@ } ] }, + "repository_projects": { + "title": "Projects", + "displayTitle": "Repository permissions for \"Projects\"", + "permissions": [ + { + "category": "projects-classic", + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "projects-classic", + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "projects-classic", + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "pull_requests": { "title": "Pull requests", "displayTitle": "Repository permissions for \"Pull requests\"", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json index a33009c7cb1f..7aaed912f2ab 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json @@ -3129,6 +3129,146 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects" + }, + { + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects" + } + ], "pulls": [ { "slug": "list-pull-requests", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json index bd845f5f331d..37d3b3101acd 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json @@ -3305,6 +3305,146 @@ "requestPath": "/orgs/{org}/private-registries/{secret_name}" } ], + "projects-classic": [ + { + "slug": "list-organization-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "create-an-organization-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/orgs/{org}/projects" + }, + { + "slug": "get-a-project-card", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "update-an-existing-project-card", + "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "delete-a-project-card", + "subcategory": "cards", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}" + }, + { + "slug": "move-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves" + }, + { + "slug": "get-a-project-column", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "update-an-existing-project-column", + "subcategory": "columns", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "delete-a-project-column", + "subcategory": "columns", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}" + }, + { + "slug": "list-project-cards", + "subcategory": "cards", + "verb": "get", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "create-a-project-card", + "subcategory": "cards", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/cards" + }, + { + "slug": "move-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves" + }, + { + "slug": "get-a-project", + "subcategory": "projects", + "verb": "get", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "update-a-project", + "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "delete-a-project", + "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/{project_id}" + }, + { + "slug": "list-project-collaborators", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators" + }, + { + "slug": "add-project-collaborator", + "subcategory": "collaborators", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "remove-user-as-a-collaborator", + "subcategory": "collaborators", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}" + }, + { + "slug": "get-project-permission-for-a-user", + "subcategory": "collaborators", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission" + }, + { + "slug": "list-project-columns", + "subcategory": "columns", + "verb": "get", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "create-a-project-column", + "subcategory": "columns", + "verb": "post", + "requestPath": "/projects/{project_id}/columns" + }, + { + "slug": "list-repository-projects", + "subcategory": "projects", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects" + }, + { + "slug": "create-a-repository-project", + "subcategory": "projects", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/projects" + } + ], "pulls": [ { "slug": "list-pull-requests", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index e012f593d05e..0e46bf1330af 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "2c7afd9c1987eeb90da554f9bf12df48ca88ba33" + "sha": "1a8e746d3e6e8faaef13ee92434686571cccb992" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 04928fd0f2eb..69219aa84843 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -175159,7 +175159,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all code security configurations available in an 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 write:org scope to use this endpoint.

", + "descriptionHTML": "

Lists all code security configurations available in an 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", @@ -176280,7 +176280,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the default code security configurations for an 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 write:org scope to use this endpoint.

", + "descriptionHTML": "

Lists the default code security configurations for an 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", @@ -178781,7 +178781,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the repositories associated with a code security configuration in an 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 write:org scope to use this endpoint.

", + "descriptionHTML": "

Lists the repositories associated with a code security configuration in an 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", @@ -389181,7 +389181,18 @@ "id": "openai/gpt-4.1", "name": "OpenAI GPT-4.1", "publisher": "OpenAI", + "registry": "azure-openai", "summary": "gpt-4.1 outperforms gpt-4o across the board, with major gains in coding, instruction following, and long-context understanding", + "html_url": "https://github.com/marketplace/models/azure-openai/gpt-4-1", + "version": "2025-04-14", + "capabilities": [ + "streaming", + "tool-calling" + ], + "limits": { + "max_input_tokens": 1048576, + "max_output_tokens": 32768 + }, "rate_limit_tier": "high", "supported_input_modalities": [ "text", @@ -389211,6 +389222,10 @@ "type": "string", "description": "The name of the model" }, + "registry": { + "type": "string", + "description": "The registry where the model is listed" + }, "publisher": { "type": "string", "description": "The publisher of the model" @@ -389223,6 +389238,35 @@ "type": "string", "description": "The rate limit tier for the model" }, + "html_url": { + "type": "string", + "description": "The URL to the model's detail page" + }, + "version": { + "type": "string", + "description": "The version of the model" + }, + "capabilities": { + "type": "array", + "description": "A list of capabilities supported by the model", + "items": { + "type": "string" + } + }, + "limits": { + "type": "object", + "description": "The limits for the model, including input/output token limits", + "properties": { + "max_input_tokens": { + "type": "integer", + "description": "The maximum number of input tokens allowed" + }, + "max_output_tokens": { + "type": "integer", + "description": "The maximum number of output tokens allowed" + } + } + }, "tags": { "type": "array", "description": "A list of tags associated with the model", @@ -438550,489 +438594,60 @@ } ] }, - "projects": { - "projects": [ + "projects-classic": { + "cards": [ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/projects", - "title": "List organization projects", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Get a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "

Indicates the state of the projects to return.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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 + "type": "integer" } } ], "bodyParameters": [], - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": true - } - ], - "schema": { - "type": "array", - "items": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "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": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "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": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/orgs/{org}/projects", - "title": "Create an organization project", - "category": "projects", - "subcategory": "projects", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" + { + "\"Projects\" organization permissions": "read" } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "

The name of the project.

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

The description of the project.

" - } - ], + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - }, "parameters": { - "org": "ORG" + "card_id": "CARD_ID" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", + "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, @@ -439053,82 +438668,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -439310,437 +438889,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "2016-09-05T14:20:22Z" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "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": "201", - "description": "

Created

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

Requires authentication

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

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

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

The unique identifier of the project.

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

Response

", - "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", - "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": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - }, - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean", "examples": [ - "https://api.github.com/repos/api-playground/projects-test" + false ] }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] + "column_name": { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] + "project_id": { + "type": "string" }, - "columns_url": { + "column_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "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" - ] - } + "https://api.github.com/projects/columns/367" ] }, - "created_at": { + "content_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2011-04-10T20:09:31Z" + "https://api.github.com/repos/api-playground/projects-test/issues/3" ] }, - "updated_at": { + "project_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "https://api.github.com/projects/120" ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" } }, "required": [ "id", "node_id", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -439766,20 +438967,24 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

The unique identifier of the project.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { @@ -439788,57 +438993,44 @@ } ], "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "

Name of the project

" - }, { "type": "string or null", - "name": "body", - "in": "body", - "description": "

Body of the project

" - }, - { - "type": "string", - "name": "state", - "in": "body", - "description": "

State of the project; either 'open' or 'closed'

" - }, - { - "type": "string", - "name": "organization_permission", + "name": "note", "in": "body", - "description": "

The baseline permission that all organization members have on this project

", - "enum": [ - "read", - "write", - "admin", - "none" - ] + "description": "

The project card's note

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

Whether or not this project can be seen by everyone.

" + "description": "

Whether or not the card is archived

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Change the name, state, and permissions for a project", + "description": "Change the note on the card", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" + "note": "Add payload for delete Project column" }, "parameters": { - "project_id": "PROJECT_ID" + "card_id": "CARD_ID" } }, "response": { @@ -439846,16 +439038,10 @@ "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -439876,82 +439062,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -440133,43 +439283,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -440198,11 +439364,7 @@ }, { "httpStatusCode": "404", - "description": "

Not Found if the authenticated user does not have access to the project

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

Gone

" + "description": "

Resource not found

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

The unique identifier of the project.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { @@ -440229,6 +439391,19 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "204", @@ -440236,12 +439411,12 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "project_id": "PROJECT_ID" + "card_id": "CARD_ID" } }, "response": { "statusCode": "204", - "description": "

Delete Success

" + "description": "

Response

" } } ], @@ -440250,7 +439425,7 @@ "statusCodes": [ { "httpStatusCode": "204", - "description": "

Delete Success

" + "description": "

No Content

" }, { "httpStatusCode": "304", @@ -440267,52 +439442,142 @@ { "httpStatusCode": "404", "description": "

Resource not found

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

Gone

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

The account owner of the repository. The name is not case sensitive.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { - "type": "string" + "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 }, { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "type": "integer", + "name": "column_id", + "in": "body", + "description": "

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

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "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": "string" + "type": "integer" } }, { - "name": "state", - "description": "

Indicates the state of the projects to return.

", + "name": "archived_state", + "description": "

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

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "open", - "closed", - "all" + "all", + "archived", + "not_archived" ], - "default": "open" + "default": "not_archived" } }, { @@ -440335,6 +439600,20 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", @@ -440342,8 +439621,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "column_id": "COLUMN_ID" } }, "response": { @@ -440352,16 +439630,10 @@ "description": "

Response

", "example": [ { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -440382,85 +439654,49 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -440642,43 +439878,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -440694,6 +439946,10 @@ "httpStatusCode": "200", "description": "

OK

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

Not modified

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

Requires authentication

" @@ -440701,77 +439957,75 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/projects", - "title": "Create a repository project", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/{column_id}/cards", + "title": "Create a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "column_id", + "description": "

The unique identifier of the column.

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

The name of the project.

", + "description": "

The project card's note

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

The unique identifier of the content associated with the card

", "isRequired": true }, { "type": "string", - "name": "body", + "name": "content_type", "in": "body", - "description": "

The description of the project.

" + "description": "

The piece of content associated with the card

", + "isRequired": true } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Create a new card", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site." + "note": "Add payload for delete Project column" }, "parameters": { - "owner": "OWNER", - "repo": "REPO" + "column_id": "COLUMN_ID" } }, "response": { @@ -440779,16 +440033,10 @@ "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -440809,82 +440057,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -441066,43 +440278,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -441117,6 +440345,10 @@ "httpStatusCode": "201", "description": "

Created

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

Not modified

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

Requires authentication

" @@ -441126,12 +440358,314 @@ "description": "

Forbidden

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

Resource not found

" + "httpStatusCode": "422", + "description": "

Validation failed

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

Gone

" + "httpStatusCode": "503", + "description": "

Service Unavailable

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

The unique identifier of the project.

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

Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "outside", + "direct", + "all" + ], + "default": "all" + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "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 + } + ], + "schema": { + "type": "array", + "items": { + "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" + ] + } + } + } + } + ], + "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", @@ -441141,55 +440675,254 @@ }, { "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/user/projects", - "title": "Create a user project", - "category": "projects", - "subcategory": "projects", - "parameters": [], + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "title": "Add project collaborator", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

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

Name of the project

", - "isRequired": true + "description": "

The permission to grant the collaborator.

", + "enum": [ + "read", + "write", + "admin" + ], + "default": "write" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Applying write permissions for the new collaborator", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "write" + }, + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "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

" }, { - "type": "string or null", - "name": "body", - "in": "body", - "description": "

Body of the project

" + "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/{project_id}/collaborators/{username}", + "title": "Remove user as a collaborator", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "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

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

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "title": "Get project permission for a user", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", - "description": "Create a new project", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "My Projects", - "body": "A board to manage my personal projects." + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "number": 1, - "state": "open", - "creator": { + "permission": "admin", + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -441208,86 +440941,17 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + } }, "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Collaborator Permission", + "description": "Project Collaborator Permission", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] + "permission": { + "type": "string" }, - "creator": { + "user": { "anyOf": [ { "type": "null" @@ -441461,48 +441125,172 @@ ] } ] + } + }, + "required": [ + "permission", + "user" + ] + } + } + } + ], + "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.

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

The unique identifier of the column.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "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/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] }, - "created_at": { + "project_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2011-04-10T20:09:31Z" + "https://api.github.com/projects/120" ] }, - "updated_at": { + "cards_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2014-03-03T18:58:10Z" + "https://api.github.com/projects/columns/367/cards" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] } }, "required": [ "id", "node_id", - "number", - "name", - "body", - "state", "url", - "html_url", - "owner_url", - "creator", - "columns_url", + "project_url", + "cards_url", + "name", "created_at", "updated_at" ] @@ -441514,8 +441302,8 @@ "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": "200", + "description": "

OK

" }, { "httpStatusCode": "304", @@ -441530,94 +441318,775 @@ "description": "

Forbidden

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

Validation failed, or the endpoint has been spammed.

" + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/users/{username}/projects", - "title": "List user projects", - "category": "projects", - "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "title": "Update an existing project column", + "category": "projects-classic", + "subcategory": "columns", "parameters": [ { - "name": "username", - "description": "

The handle for the GitHub user account.

", + "name": "column_id", + "description": "

The unique identifier of the column.

", "in": "path", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "

Indicates the state of the projects to return.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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 + "type": "integer" } - }, + } + ], + "bodyParameters": [ { - "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 - } + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the project column

", + "isRequired": true } ], - "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Rename the project column", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "To Do" + }, "parameters": { - "username": "USERNAME" + "column_id": "COLUMN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "

Response

", - "example": [ - { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "example": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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

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

The unique identifier of the column.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "column_id": "COLUMN_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

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

The unique identifier of the column.

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

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Move the column to the end of the board", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "position": "last" + }, + "parameters": { + "column_id": "COLUMN_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.

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

The unique identifier of the project.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "title": "Create a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

Name of the project column

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Remaining tasks" + }, + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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": "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.

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

The organization name. The name is not case sensitive.

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

Indicates the state of the projects to return.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "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", @@ -441633,8 +442102,10 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", + "private": true } ], "schema": { @@ -441950,47 +442421,80 @@ "description": "

Validation failed, or the endpoint has been spammed.

" } ] - } - ], - "cards": [ + }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Get a project card", - "category": "projects", - "subcategory": "cards", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "title": "Create an organization project", + "category": "projects-classic", + "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" } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

The name of the project.

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

The description of the project.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year." + }, "parameters": { - "card_id": "CARD_ID" + "org": "ORG" } }, "response": { - "statusCode": "200", + "statusCode": "201", "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", + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -442011,46 +442515,82 @@ "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" + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -442232,59 +442772,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -442296,12 +442820,8 @@ "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": "201", + "description": "

Created

" }, { "httpStatusCode": "401", @@ -442314,20 +442834,28 @@ { "httpStatusCode": "404", "description": "

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

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

The unique identifier of the card.

", + "name": "project_id", + "description": "

The unique identifier of the project.

", "in": "path", "required": true, "schema": { @@ -442335,32 +442863,29 @@ } } ], - "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

" - } - ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", - "description": "Change the note on the card", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "note": "Add payload for delete Project column" - }, "parameters": { - "card_id": "CARD_ID" + "project_id": "PROJECT_ID" } }, "response": { @@ -442368,10 +442893,16 @@ "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", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -442392,58 +442923,94 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" ] }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { "name": { "type": [ "string", @@ -442613,59 +443180,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -442691,28 +443242,20 @@ { "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", - "subcategory": "cards", + "verb": "patch", + "requestPath": "/projects/{project_id}", + "title": "Update a project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "project_id", + "description": "

The unique identifier of the project.

", "in": "path", "required": true, "schema": { @@ -442720,20 +443263,406 @@ } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the project

" + }, + { + "type": "string or null", + "name": "body", + "in": "body", + "description": "

Body of the project

" + }, + { + "type": "string", + "name": "state", + "in": "body", + "description": "

State of the project; either 'open' or 'closed'

" + }, + { + "type": "string", + "name": "organization_permission", + "in": "body", + "description": "

The baseline permission that all organization members have on this project

", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + { + "type": "boolean", + "name": "private", + "in": "body", + "description": "

Whether or not this project can be seen by everyone.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { - "key": "204", + "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Change the name, state, and permissions for a project", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Week One Sprint", + "state": "open", + "organization_permission": "write" + }, "parameters": { - "card_id": "CARD_ID" + "project_id": "PROJECT_ID" } }, "response": { - "statusCode": "204", - "description": "

Response

" + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", + "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": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + }, + "schema": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "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": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "created_at", + "updated_at" + ] + } } } ], @@ -442741,8 +443670,8 @@ "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": "200", + "description": "

OK

" }, { "httpStatusCode": "304", @@ -442758,21 +443687,29 @@ }, { "httpStatusCode": "404", - "description": "

Resource not found

" + "description": "

Not Found if the authenticated user does not have access to the project

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

Gone

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

Validation failed, or the endpoint has been spammed.

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

The unique identifier of the card.

", + "name": "project_id", + "description": "

The unique identifier of the project.

", "in": "path", "required": true, "schema": { @@ -442780,46 +443717,33 @@ } } ], - "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

" - } - ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { - "key": "default", + "key": "204", "request": { - "contentType": "application/json", - "description": "Move the card to the bottom of the column", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "column_id": 42, - "position": "bottom" - }, "parameters": { - "card_id": "CARD_ID" + "project_id": "PROJECT_ID" } }, "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": null, - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - } + "statusCode": "204", + "description": "

Delete Success

" } } ], @@ -442827,8 +443751,8 @@ "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": "204", + "description": "

Delete Success

" }, { "httpStatusCode": "304", @@ -442843,45 +443767,54 @@ "description": "

Forbidden

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

Validation failed, or the endpoint has been spammed.

" + "httpStatusCode": "404", + "description": "

Resource not found

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

Service Unavailable

" + "httpStatusCode": "410", + "description": "

Gone

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

The unique identifier of the column.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

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

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

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

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

Indicates the state of the projects to return.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "all", - "archived", - "not_archived" + "open", + "closed", + "all" ], - "default": "not_archived" + "default": "open" } }, { @@ -442904,6 +443837,17 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", @@ -442911,7 +443855,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "column_id": "COLUMN_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -442920,10 +443865,16 @@ "description": "

Response

", "example": [ { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -442944,49 +443895,85 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" } ], "schema": { "type": "array", "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -443168,59 +444155,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -443236,10 +444207,6 @@ "httpStatusCode": "200", "description": "

OK

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

Not modified

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

Requires authentication

" @@ -443247,62 +444214,87 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "Create a project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/repos/{owner}/{repo}/projects", + "title": "Create a repository project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "column_id", - "description": "

The unique identifier of the column.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository without the .git extension. The name is not case sensitive.

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

The project card's note

", - "isRequired": true - }, - { - "type": "integer", - "name": "content_id", + "type": "string", + "name": "name", "in": "body", - "description": "

The unique identifier of the content associated with the card

", + "description": "

The name of the project.

", "isRequired": true }, { "type": "string", - "name": "content_type", + "name": "body", "in": "body", - "description": "

The piece of content associated with the card

", - "isRequired": true + "description": "

The description of the project.

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Create a new card", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "note": "Add payload for delete Project column" + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site." }, "parameters": { - "column_id": "COLUMN_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -443310,10 +444302,16 @@ "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", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -443334,46 +444332,82 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -443555,59 +444589,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -443622,10 +444640,6 @@ "httpStatusCode": "201", "description": "

Created

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

Not modified

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

Requires authentication

" @@ -443635,519 +444649,76 @@ "description": "

Forbidden

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

Validation failed

" + "httpStatusCode": "404", + "description": "

Resource not found

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

Service Unavailable

" + "httpStatusCode": "410", + "description": "

Gone

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

Validation failed, or the endpoint has been spammed.

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

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, + "verb": "post", + "requestPath": "/user/projects", + "title": "Create a user project", + "category": "projects-classic", + "subcategory": "projects", + "parameters": [], + "bodyParameters": [ { - "name": "affiliation", - "description": "

Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the project

", + "isRequired": true }, { - "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": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "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" - ] - } - } - } - } - ], - "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": "put", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Add project collaborator", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

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

The permission to grant the collaborator.

", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write" + "description": "

Body of the project

" } ], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, "codeExamples": [ { - "key": "204", + "key": "default", "request": { "contentType": "application/json", - "description": "Applying write permissions for the new collaborator", + "description": "Create a new project", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "permission": "write" - }, - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" - } - }, - "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

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Remove user as a collaborator", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" - } - }, - "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

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "title": "Get project permission for a user", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" + "name": "My Projects", + "body": "A board to manage my personal projects." } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "permission": "admin", - "user": { + "owner_url": "https://api.github.com/users/octocat", + "url": "https://api.github.com/projects/1002603", + "html_url": "https://github.com/users/octocat/projects/1", + "columns_url": "https://api.github.com/projects/1002603/columns", + "id": 1002603, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "name": "My Projects", + "body": "A board to manage my personal projects.", + "number": 1, + "state": "open", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -444166,17 +444737,86 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } + }, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { - "permission": { - "type": "string" + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] }, - "user": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "creator": { "anyOf": [ { "type": "null" @@ -444350,313 +444990,48 @@ ] } ] - } - }, - "required": [ - "permission", - "user" - ] - } - } - } - ], - "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.

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

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:18:44Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "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/{column_id}", - "title": "Update an existing project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

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

Name of the project column

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Rename the project column", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "To Do" - }, - "parameters": { - "column_id": "COLUMN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" + "2014-03-03T18:58:10Z" ] }, - "created_at": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "url", - "project_url", - "cards_url", + "number", "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", "updated_at" ] @@ -444666,137 +445041,6 @@ ], "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

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

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "column_id": "COLUMN_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

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

The unique identifier of the column.

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

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Move the column to the end of the board", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "position": "last" - }, - "parameters": { - "column_id": "COLUMN_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", @@ -444823,18 +445067,33 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/projects/{project_id}/columns", - "title": "List project columns", - "category": "projects", - "subcategory": "columns", + "requestPath": "/users/{username}/projects", + "title": "List user projects", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "project_id", - "description": "

The unique identifier of the project.

", + "name": "username", + "description": "

The handle for the GitHub user account.

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

Indicates the state of the projects to return.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" } }, { @@ -444857,6 +445116,12 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, "codeExamples": [ { "key": "default", @@ -444864,7 +445129,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "project_id": "PROJECT_ID" + "username": "USERNAME" } }, "response": { @@ -444873,86 +445138,333 @@ "description": "

Response

", "example": [ { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" + "owner_url": "https://api.github.com/users/octocat", + "url": "https://api.github.com/projects/1002603", + "html_url": "https://github.com/users/octocat/projects/1", + "columns_url": "https://api.github.com/projects/1002603/columns", + "id": 1002603, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "name": "My Projects", + "body": "A board to manage my personal projects.", + "number": 1, + "state": "open", + "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": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" } ], "schema": { "type": "array", "items": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "https://api.github.com/projects/1002604" ] }, - "project_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://github.com/api-playground/projects-test/projects/12" ] }, - "cards_url": { + "columns_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367/cards" + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The unique identifier of the project column", "type": "integer", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, "name": { - "description": "Name of the project column", + "description": "Name of the project", "type": "string", "examples": [ - "Remaining tasks" + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "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:18:44Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "url", - "project_url", - "cards_url", + "number", "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", "updated_at" ] @@ -444968,169 +445480,6 @@ "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": "/projects/{project_id}/columns", - "title": "Create a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Name of the project column

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Remaining tasks" - }, - "parameters": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "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": "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.

" diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index d566b8eb8f6c..d9eec5835c02 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -187580,7 +187580,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all code security configurations available in an 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 write:org scope to use this endpoint.

", + "descriptionHTML": "

Lists all code security configurations available in an 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", @@ -188701,7 +188701,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the default code security configurations for an 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 write:org scope to use this endpoint.

", + "descriptionHTML": "

Lists the default code security configurations for an 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", @@ -191202,7 +191202,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the repositories associated with a code security configuration in an 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 write:org scope to use this endpoint.

", + "descriptionHTML": "

Lists the repositories associated with a code security configuration in an 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", @@ -481030,489 +481030,60 @@ } ] }, - "projects": { - "projects": [ + "projects-classic": { + "cards": [ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/orgs/{org}/projects", - "title": "List organization projects", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Get a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "

Indicates the state of the projects to return.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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 + "type": "integer" } } ], "bodyParameters": [], - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": true - } - ], - "schema": { - "type": "array", - "items": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "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": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "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": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/orgs/{org}/projects", - "title": "Create an organization project", - "category": "projects", - "subcategory": "projects", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" + { + "\"Projects\" organization permissions": "read" } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "

The name of the project.

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

The description of the project.

" - } - ], + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - }, "parameters": { - "org": "ORG" + "card_id": "CARD_ID" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", + "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, @@ -481533,82 +481104,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -481790,43 +481325,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -481838,8 +481389,12 @@ "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": "200", + "description": "

OK

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

Not modified

" }, { "httpStatusCode": "401", @@ -481852,28 +481407,20 @@ { "httpStatusCode": "404", "description": "

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

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

The unique identifier of the project.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { @@ -481881,15 +481428,45 @@ } } ], - "bodyParameters": [], + "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

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { - "description": "Example", + "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": { - "project_id": "PROJECT_ID" + "card_id": "CARD_ID" } }, "response": { @@ -481897,16 +481474,10 @@ "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -481927,82 +481498,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -482184,43 +481719,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -482246,20 +481797,28 @@ { "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": "patch", - "requestPath": "/projects/{project_id}", - "title": "Update a project", - "category": "projects", - "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Delete a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "project_id", - "description": "

The unique identifier of the project.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { @@ -482267,392 +481826,131 @@ } } ], - "bodyParameters": [ + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ { - "type": "string", - "name": "name", - "in": "body", - "description": "

Name of the project

" + "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

" }, { - "type": "string or null", - "name": "body", - "in": "body", - "description": "

Body of the project

" + "httpStatusCode": "304", + "description": "

Not modified

" }, { - "type": "string", - "name": "state", - "in": "body", - "description": "

State of the project; either 'open' or 'closed'

" + "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": "organization_permission", + "name": "position", "in": "body", - "description": "

The baseline permission that all organization members have on this project

", - "enum": [ - "read", - "write", - "admin", - "none" - ] + "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": "boolean", - "name": "private", + "type": "integer", + "name": "column_id", "in": "body", - "description": "

Whether or not this project can be seen by everyone.

" + "description": "

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

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Change the name, state, and permissions for a project", + "description": "Move the card to the bottom of the column", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" + "column_id": 42, + "position": "bottom" }, "parameters": { - "project_id": "PROJECT_ID" + "card_id": "CARD_ID" } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "

Response

", - "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", - "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": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - }, + "example": null, "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "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": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] + "properties": {}, + "additionalProperties": false } } } @@ -482661,8 +481959,8 @@ "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": "201", + "description": "

Created

" }, { "httpStatusCode": "304", @@ -482676,123 +481974,46 @@ "httpStatusCode": "403", "description": "

Forbidden

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

Not Found if the authenticated user does not have access to the project

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

Gone

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

Validation failed, or the endpoint has been spammed.

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

The unique identifier of the project.

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

Delete Success

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

Delete Success

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

Not modified

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

Requires authentication

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

Forbidden

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

Resource not found

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

Gone

" + "httpStatusCode": "503", + "description": "

Service Unavailable

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

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "column_id", + "description": "

The unique identifier of the column.

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

Indicates the state of the projects to return.

", + "name": "archived_state", + "description": "

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

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "open", - "closed", - "all" + "all", + "archived", + "not_archived" ], - "default": "open" + "default": "not_archived" } }, { @@ -482815,6 +482036,20 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", @@ -482822,8 +482057,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "column_id": "COLUMN_ID" } }, "response": { @@ -482832,16 +482066,10 @@ "description": "

Response

", "example": [ { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -482862,85 +482090,49 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -483122,43 +482314,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -483174,6 +482382,10 @@ "httpStatusCode": "200", "description": "

OK

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

Not modified

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

Requires authentication

" @@ -483181,77 +482393,75 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/projects", - "title": "Create a repository project", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/{column_id}/cards", + "title": "Create a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "column_id", + "description": "

The unique identifier of the column.

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

The name of the project.

", + "description": "

The project card's note

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

The unique identifier of the content associated with the card

", "isRequired": true }, { "type": "string", - "name": "body", + "name": "content_type", "in": "body", - "description": "

The description of the project.

" + "description": "

The piece of content associated with the card

", + "isRequired": true } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Create a new card", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site." + "note": "Add payload for delete Project column" }, "parameters": { - "owner": "OWNER", - "repo": "REPO" + "column_id": "COLUMN_ID" } }, "response": { @@ -483259,16 +482469,10 @@ "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -483289,82 +482493,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -483546,43 +482714,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -483597,6 +482781,10 @@ "httpStatusCode": "201", "description": "

Created

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

Not modified

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

Requires authentication

" @@ -483606,70 +482794,98 @@ "description": "

Forbidden

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

Resource not found

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

Gone

" + "httpStatusCode": "422", + "description": "

Validation failed

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

Validation failed, or the endpoint has been spammed.

" + "httpStatusCode": "503", + "description": "

Service Unavailable

" } ] - }, + } + ], + "collaborators": [ { "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/user/projects", - "title": "Create a user project", - "category": "projects", - "subcategory": "projects", - "parameters": [], - "bodyParameters": [ + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "title": "List project collaborators", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ { - "type": "string", - "name": "name", - "in": "body", - "description": "

Name of the project

", - "isRequired": true + "name": "project_id", + "description": "

The unique identifier of the project.

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

Body of the project

" + "name": "affiliation", + "description": "

Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "outside", + "direct", + "all" + ], + "default": "all" + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", - "description": "Create a new project", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "My Projects", - "body": "A board to manage my personal projects." + "parameters": { + "project_id": "PROJECT_ID" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", - "example": { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "number": 1, - "state": "open", - "creator": { + "example": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -483688,86 +482904,490 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - }, + } + ], "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] + "type": "array", + "items": { + "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" + ] + } }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] + "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" + ] + } + } + } + } + ], + "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": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "title": "Add project collaborator", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

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

The permission to grant the collaborator.

", + "enum": [ + "read", + "write", + "admin" + ], + "default": "write" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Applying write permissions for the new collaborator", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "write" + }, + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "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

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

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "title": "Remove user as a collaborator", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "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

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

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "title": "Get project permission for a user", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "permission": "admin", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "schema": { + "title": "Project Collaborator Permission", + "description": "Project Collaborator Permission", + "type": "object", + "properties": { + "permission": { + "type": "string" }, - "creator": { + "user": { "anyOf": [ { "type": "null" @@ -483941,48 +483561,340 @@ ] } ] + } + }, + "required": [ + "permission", + "user" + ] + } + } + } + ], + "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.

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

The unique identifier of the column.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "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/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:18:44Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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/{column_id}", + "title": "Update an existing project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

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

Name of the project column

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Rename the project column", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "To Do" + }, + "parameters": { + "column_id": "COLUMN_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "project_url": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] } }, "required": [ "id", "node_id", - "number", - "name", - "body", - "state", "url", - "html_url", - "owner_url", - "creator", - "columns_url", + "project_url", + "cards_url", + "name", "created_at", "updated_at" ] @@ -483992,6 +483904,163 @@ ], "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

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

The unique identifier of the column.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "column_id": "COLUMN_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

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

The unique identifier of the column.

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

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Move the column to the end of the board", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "position": "last" + }, + "parameters": { + "column_id": "COLUMN_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", @@ -484018,14 +484087,360 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/users/{username}/projects", - "title": "List user projects", - "category": "projects", + "requestPath": "/projects/{project_id}/columns", + "title": "List project columns", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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

" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "title": "Create a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

Name of the project column

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Remaining tasks" + }, + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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": "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.

" + } + ] + } + ], + "projects": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "title": "List organization projects", + "category": "projects-classic", "subcategory": "projects", "parameters": [ { - "name": "username", - "description": "

The handle for the GitHub user account.

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

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -484067,6 +484482,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -484074,7 +484499,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "username": "USERNAME" + "org": "ORG" } }, "response": { @@ -484083,14 +484508,14 @@ "description": "

Response

", "example": [ { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "creator": { @@ -484113,8 +484538,10 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", + "private": true } ], "schema": { @@ -484430,47 +484857,80 @@ "description": "

Validation failed, or the endpoint has been spammed.

" } ] - } - ], - "cards": [ + }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Get a project card", - "category": "projects", - "subcategory": "cards", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "title": "Create an organization project", + "category": "projects-classic", + "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" } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

The name of the project.

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

The description of the project.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year." + }, "parameters": { - "card_id": "CARD_ID" + "org": "ORG" } }, "response": { - "statusCode": "200", + "statusCode": "201", "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", + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -484491,46 +484951,82 @@ "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" + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -484712,59 +485208,451 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:20:22Z" + "2014-03-03T18:58:10Z" ] }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", - "examples": [ - false + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "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": "201", + "description": "

Created

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

Requires authentication

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

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

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

The unique identifier of the project.

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

Response

", + "example": { + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", + "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": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + }, + "schema": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] }, - "column_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "https://api.github.com/projects/1002604" ] }, - "content_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "https://github.com/api-playground/projects-test/projects/12" ] }, - "project_url": { + "columns_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "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": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -484790,24 +485678,20 @@ { "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", - "subcategory": "cards", + "requestPath": "/projects/{project_id}", + "title": "Update a project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "project_id", + "description": "

The unique identifier of the project.

", "in": "path", "required": true, "schema": { @@ -484816,31 +485700,70 @@ } ], "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the project

" + }, { "type": "string or null", - "name": "note", + "name": "body", "in": "body", - "description": "

The project card's note

" + "description": "

Body of the project

" + }, + { + "type": "string", + "name": "state", + "in": "body", + "description": "

State of the project; either 'open' or 'closed'

" + }, + { + "type": "string", + "name": "organization_permission", + "in": "body", + "description": "

The baseline permission that all organization members have on this project

", + "enum": [ + "read", + "write", + "admin", + "none" + ] }, { "type": "boolean", - "name": "archived", + "name": "private", "in": "body", - "description": "

Whether or not the card is archived

" + "description": "

Whether or not this project can be seen by everyone.

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Change the note on the card", + "description": "Change the name, state, and permissions for a project", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "note": "Add payload for delete Project column" + "name": "Week One Sprint", + "state": "open", + "organization_permission": "write" }, "parameters": { - "card_id": "CARD_ID" + "project_id": "PROJECT_ID" } }, "response": { @@ -484848,10 +485771,16 @@ "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", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -484872,46 +485801,82 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -485093,59 +486058,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "project_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" + "enum": [ + "read", + "write", + "admin", + "none" ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -485174,7 +486123,11 @@ }, { "httpStatusCode": "404", - "description": "

Resource not found

" + "description": "

Not Found if the authenticated user does not have access to the project

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

Gone

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

The unique identifier of the card.

", + "name": "project_id", + "description": "

The unique identifier of the project.

", "in": "path", "required": true, "schema": { @@ -485201,6 +486154,19 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "204", @@ -485208,12 +486174,12 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "card_id": "CARD_ID" + "project_id": "PROJECT_ID" } }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

Delete Success

" } } ], @@ -485222,7 +486188,7 @@ "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

Delete Success

" }, { "httpStatusCode": "304", @@ -485239,129 +486205,52 @@ { "httpStatusCode": "404", "description": "

Resource not found

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

Gone

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

The unique identifier of the card.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "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 - } + "type": "string" } - } - ], - "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", - "subcategory": "cards", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

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

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

", + "name": "state", + "description": "

Indicates the state of the projects to return.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "all", - "archived", - "not_archived" + "open", + "closed", + "all" ], - "default": "not_archived" + "default": "open" } }, { @@ -485384,6 +486273,17 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", @@ -485391,7 +486291,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "column_id": "COLUMN_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -485400,10 +486301,16 @@ "description": "

Response

", "example": [ { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -485424,49 +486331,85 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" } ], "schema": { "type": "array", "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -485648,59 +486591,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -485716,10 +486643,6 @@ "httpStatusCode": "200", "description": "

OK

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

Not modified

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

Requires authentication

" @@ -485727,62 +486650,87 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "https://api.github.com", "verb": "post", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "Create a project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/repos/{owner}/{repo}/projects", + "title": "Create a repository project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "column_id", - "description": "

The unique identifier of the column.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository without the .git extension. The name is not case sensitive.

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

The project card's note

", - "isRequired": true - }, - { - "type": "integer", - "name": "content_id", + "type": "string", + "name": "name", "in": "body", - "description": "

The unique identifier of the content associated with the card

", + "description": "

The name of the project.

", "isRequired": true }, { "type": "string", - "name": "content_type", + "name": "body", "in": "body", - "description": "

The piece of content associated with the card

", - "isRequired": true + "description": "

The description of the project.

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Create a new card", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "note": "Add payload for delete Project column" + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site." }, "parameters": { - "column_id": "COLUMN_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -485790,10 +486738,16 @@ "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", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -485814,46 +486768,82 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -486035,59 +487025,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -486102,303 +487076,6 @@ "httpStatusCode": "201", "description": "

Created

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

Not modified

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

Requires authentication

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

Forbidden

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

Validation failed

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

Service Unavailable

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

The unique identifier of the project.

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

Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "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": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "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" - ] - } - } - } - } - ], - "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

" @@ -486411,6 +487088,10 @@ "httpStatusCode": "404", "description": "

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" @@ -486419,215 +487100,61 @@ }, { "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Add project collaborator", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], + "verb": "post", + "requestPath": "/user/projects", + "title": "Create a user project", + "category": "projects-classic", + "subcategory": "projects", + "parameters": [], "bodyParameters": [ { "type": "string", - "name": "permission", + "name": "name", "in": "body", - "description": "

The permission to grant the collaborator.

", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write" - } - ], - "codeExamples": [ - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Applying write permissions for the new collaborator", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "permission": "write" - }, - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" - } - }, - "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

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Remove user as a collaborator", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" - } - }, - "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

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "title": "Get project permission for a user", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Name of the project

", + "isRequired": true }, { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "string or null", + "name": "body", + "in": "body", + "description": "

Body of the project

" } ], - "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, "codeExamples": [ { "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Create a new project", "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" + "bodyParameters": { + "name": "My Projects", + "body": "A board to manage my personal projects." } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "permission": "admin", - "user": { + "owner_url": "https://api.github.com/users/octocat", + "url": "https://api.github.com/projects/1002603", + "html_url": "https://github.com/users/octocat/projects/1", + "columns_url": "https://api.github.com/projects/1002603/columns", + "id": 1002603, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "name": "My Projects", + "body": "A board to manage my personal projects.", + "number": 1, + "state": "open", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -486646,17 +487173,86 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } + }, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { - "permission": { - "type": "string" + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] }, - "user": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "creator": { "anyOf": [ { "type": "null" @@ -486830,313 +487426,48 @@ ] } ] - } - }, - "required": [ - "permission", - "user" - ] - } - } - } - ], - "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.

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

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:18:44Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "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/{column_id}", - "title": "Update an existing project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

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

Name of the project column

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Rename the project column", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "To Do" - }, - "parameters": { - "column_id": "COLUMN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" + "2014-03-03T18:58:10Z" ] }, - "created_at": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "url", - "project_url", - "cards_url", + "number", "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", "updated_at" ] @@ -487146,137 +487477,6 @@ ], "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

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

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "column_id": "COLUMN_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

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

The unique identifier of the column.

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

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Move the column to the end of the board", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "position": "last" - }, - "parameters": { - "column_id": "COLUMN_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", @@ -487303,18 +487503,33 @@ { "serverUrl": "https://api.github.com", "verb": "get", - "requestPath": "/projects/{project_id}/columns", - "title": "List project columns", - "category": "projects", - "subcategory": "columns", + "requestPath": "/users/{username}/projects", + "title": "List user projects", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "project_id", - "description": "

The unique identifier of the project.

", + "name": "username", + "description": "

The handle for the GitHub user account.

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

Indicates the state of the projects to return.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" } }, { @@ -487337,6 +487552,12 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, "codeExamples": [ { "key": "default", @@ -487344,7 +487565,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "project_id": "PROJECT_ID" + "username": "USERNAME" } }, "response": { @@ -487353,86 +487574,333 @@ "description": "

Response

", "example": [ { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" + "owner_url": "https://api.github.com/users/octocat", + "url": "https://api.github.com/projects/1002603", + "html_url": "https://github.com/users/octocat/projects/1", + "columns_url": "https://api.github.com/projects/1002603/columns", + "id": 1002603, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "name": "My Projects", + "body": "A board to manage my personal projects.", + "number": 1, + "state": "open", + "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": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" } ], "schema": { "type": "array", "items": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "https://api.github.com/projects/1002604" ] }, - "project_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://github.com/api-playground/projects-test/projects/12" ] }, - "cards_url": { + "columns_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367/cards" + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The unique identifier of the project column", "type": "integer", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, "name": { - "description": "Name of the project column", + "description": "Name of the project", "type": "string", "examples": [ - "Remaining tasks" + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "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:18:44Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "url", - "project_url", - "cards_url", + "number", "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", "updated_at" ] @@ -487448,169 +487916,6 @@ "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": "/projects/{project_id}/columns", - "title": "Create a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Name of the project column

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Remaining tasks" - }, - "parameters": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "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": "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.

" 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 a48027786c24..c602d99dcdc9 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 @@ -264,13 +264,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all artifacts for a repository.

\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 all artifacts for a repository.

\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", @@ -1228,13 +1228,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the total GitHub Actions cache usage for an organization.\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

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

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

OK

" } - ] + ], + "descriptionHTML": "

Gets the total GitHub Actions cache usage for an organization.\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

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

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

Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

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

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

No Content

" } - ] + ], + "descriptionHTML": "

Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

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

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

Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"

\n

If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.

\n

To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.

\n

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 actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"

\n

If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.

\n

To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.

\n

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

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

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user 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": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user 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", @@ -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", @@ -8427,13 +8427,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a secret in a repository 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 the repo scope to use this endpoint.

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

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a secret in a repository 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 the repo scope to use this endpoint.

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

Deletes 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": "

Deletes 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", @@ -10665,13 +10665,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", @@ -11069,13 +11069,13 @@ } ], "previews": [], - "descriptionHTML": "

Creates a new 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": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Creates a new 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", @@ -11463,13 +11463,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", @@ -17355,13 +17355,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", @@ -21084,13 +21084,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin 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": "

Lists binaries for the runner application that you can download and run.

\n

Authenticated users must have admin 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": "http(s)://HOSTNAME/api/v3", @@ -23670,13 +23670,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific self-hosted runner configured in a repository.

\n

Authenticated users must have admin 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 specific self-hosted runner configured in a repository.

\n

Authenticated users must have admin 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": "http(s)://HOSTNAME/api/v3", @@ -26740,13 +26740,13 @@ } ], "previews": [], - "descriptionHTML": "

Creates 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 tokens and personal access tokens (classic) need the repo scope to use this endpoint.

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

Created

" } - ] + ], + "descriptionHTML": "

Creates 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 tokens and personal access tokens (classic) need the repo scope to use this endpoint.

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

Gets a specific workflow run attempt.

\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 specific workflow run attempt.

\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", @@ -43800,13 +43800,13 @@ } ], "previews": [], - "descriptionHTML": "

You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\n

You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see \"Events that trigger workflows.\"

\n

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

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

No Content

" } - ] + ], + "descriptionHTML": "

You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\n

You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see \"Events that trigger workflows.\"

\n

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

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -59085,13 +59085,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", @@ -90544,13 +90544,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", @@ -90729,13 +90729,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.

" } ] }, @@ -99867,13 +99867,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", @@ -132089,7 +132089,6 @@ } ], "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

Grants the specified teams push access for this branch. You can also give push access to child teams.

", "statusCodes": [ { "httpStatusCode": "200", @@ -132099,7 +132098,8 @@ "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.

\n

Grants the specified teams push access for this branch. You can also give push access to child teams.

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -139790,13 +139790,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": "http(s)://HOSTNAME/api/v3", @@ -163289,13 +163289,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -187025,13 +187025,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", @@ -188805,13 +188805,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

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

Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.

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

No Content

" } - ] + ], + "descriptionHTML": "

Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.

" } ] }, @@ -200984,13 +200984,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -201483,13 +201483,13 @@ } ], "previews": [], - "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "" } ], "announcement": [ @@ -205298,7 +205298,6 @@ } ], "previews": [], - "descriptionHTML": "

Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.

\n

Note

\n

\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.

\n
", "statusCodes": [ { "httpStatusCode": "201", @@ -205316,7 +205315,8 @@ "httpStatusCode": "500", "description": "

Internal error

" } - ] + ], + "descriptionHTML": "

Uploads a new enterprise license. In order to apply it right away, use the apply query parameter.

\n

Note

\n

\nThe request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.

\n
" }, { "serverUrl": "http(s)://HOSTNAME", @@ -208433,13 +208433,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", @@ -220137,13 +220137,13 @@ } ], "previews": [], - "descriptionHTML": "

You can demote any user account except your own.

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

No Content

" } - ] + ], + "descriptionHTML": "

You can demote any user account except your own.

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

You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

Issue comments are ordered by ascending ID.

\n

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

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -269891,7 +269890,8 @@ "httpStatusCode": "410", "description": "

Gone

" } - ] + ], + "descriptionHTML": "

You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

Issue comments are ordered by ascending ID.

\n

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

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

Lists labels for issues in a milestone.

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

OK

" } - ] + ], + "descriptionHTML": "

Lists labels for issues in a milestone.

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

Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

\n

A list of repositories is only returned for export migrations.

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

OK

" } - ] + ], + "descriptionHTML": "

Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

\n

A list of repositories is only returned for export migrations.

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

Delete a ruleset for an organization.

", "statusCodes": [ { "httpStatusCode": "204", @@ -357468,7 +357467,8 @@ "httpStatusCode": "500", "description": "

Internal Error

" } - ] + ], + "descriptionHTML": "

Delete a ruleset for an organization.

" } ], "security-managers": [ @@ -358916,13 +358916,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", @@ -372585,13 +372585,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific package metadata for a public package owned by a 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 metadata for a public package owned by a 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", @@ -375767,489 +375767,60 @@ } ] }, - "projects": { - "projects": [ + "projects-classic": { + "cards": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/orgs/{org}/projects", - "title": "List organization projects", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Get a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "

Indicates the state of the projects to return.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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 + "type": "integer" } } ], "bodyParameters": [], - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": true - } - ], - "schema": { - "type": "array", - "items": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "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": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

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

OK

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/projects", - "title": "Create an organization project", - "category": "projects", - "subcategory": "projects", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" + { + "\"Projects\" organization permissions": "read" } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "

The name of the project.

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

The description of the project.

" - } - ], + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - }, "parameters": { - "org": "ORG" + "card_id": "CARD_ID" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", + "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, @@ -376270,82 +375841,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -376527,437 +376062,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "2016-09-05T14:20:22Z" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Creates an organization project board. Returns a 410 Gone status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

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

Created

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

Requires authentication

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

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}", - "title": "Get a project", - "category": "projects", - "subcategory": "projects", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Response

", - "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", - "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": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - }, - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean", "examples": [ - "https://api.github.com/repos/api-playground/projects-test" + false ] }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] + "column_name": { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] + "project_id": { + "type": "string" }, - "columns_url": { + "column_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "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" - ] - } + "https://api.github.com/projects/columns/367" ] }, - "created_at": { + "content_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2011-04-10T20:09:31Z" + "https://api.github.com/repos/api-playground/projects-test/issues/3" ] }, - "updated_at": { + "project_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "https://api.github.com/projects/120" ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" } }, "required": [ "id", "node_id", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -376966,7 +376123,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", + "descriptionHTML": "

Gets information about a project card.

", "statusCodes": [ { "httpStatusCode": "200", @@ -376983,20 +376140,24 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "patch", - "requestPath": "/projects/{project_id}", - "title": "Update a project", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Update an existing project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "project_id", - "description": "

The unique identifier of the project.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { @@ -377005,57 +376166,44 @@ } ], "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "

Name of the project

" - }, { "type": "string or null", - "name": "body", - "in": "body", - "description": "

Body of the project

" - }, - { - "type": "string", - "name": "state", - "in": "body", - "description": "

State of the project; either 'open' or 'closed'

" - }, - { - "type": "string", - "name": "organization_permission", + "name": "note", "in": "body", - "description": "

The baseline permission that all organization members have on this project

", - "enum": [ - "read", - "write", - "admin", - "none" - ] + "description": "

The project card's note

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

Whether or not this project can be seen by everyone.

" + "description": "

Whether or not the card is archived

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Change the name, state, and permissions for a project", + "description": "Change the note on the card", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" + "note": "Add payload for delete Project column" }, "parameters": { - "project_id": "PROJECT_ID" + "card_id": "CARD_ID" } }, "response": { @@ -377063,16 +376211,10 @@ "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -377093,82 +376235,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -377350,43 +376456,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -377395,7 +376517,7 @@ } ], "previews": [], - "descriptionHTML": "

Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", + "descriptionHTML": "

Update an existing project card

", "statusCodes": [ { "httpStatusCode": "200", @@ -377415,11 +376537,7 @@ }, { "httpStatusCode": "404", - "description": "

Not Found if the authenticated user does not have access to the project

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

Gone

" + "description": "

Resource not found

" }, { "httpStatusCode": "422", @@ -377430,14 +376548,14 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "delete", - "requestPath": "/projects/{project_id}", - "title": "Delete a project", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Delete a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "project_id", - "description": "

The unique identifier of the project.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { @@ -377446,6 +376564,19 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "204", @@ -377453,21 +376584,21 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "project_id": "PROJECT_ID" + "card_id": "CARD_ID" } }, "response": { "statusCode": "204", - "description": "

Delete Success

" + "description": "

Response

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

Deletes a project board. Returns a 404 Not Found status if projects are disabled.

", + "descriptionHTML": "

Deletes a project card

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

Delete Success

" + "description": "

No Content

" }, { "httpStatusCode": "304", @@ -377484,52 +376615,142 @@ { "httpStatusCode": "404", "description": "

Resource not found

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

Gone

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/projects", - "title": "List repository projects", - "category": "projects", - "subcategory": "projects", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "title": "Move a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { - "type": "string" + "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 }, { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "type": "integer", + "name": "column_id", + "in": "body", + "description": "

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

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "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": "

Move a project card

", + "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": "http(s)://HOSTNAME/api/v3", + "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": "string" + "type": "integer" } }, { - "name": "state", - "description": "

Indicates the state of the projects to return.

", + "name": "archived_state", + "description": "

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

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "open", - "closed", - "all" + "all", + "archived", + "not_archived" ], - "default": "open" + "default": "not_archived" } }, { @@ -377552,6 +376773,20 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", @@ -377559,8 +376794,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "column_id": "COLUMN_ID" } }, "response": { @@ -377569,16 +376803,10 @@ "description": "

Response

", "example": [ { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -377599,85 +376827,49 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -377859,43 +377051,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -377905,12 +377113,16 @@ } ], "previews": [], - "descriptionHTML": "

Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", + "descriptionHTML": "

Lists the project cards in a project.

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

OK

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

Not modified

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

Requires authentication

" @@ -377918,77 +377130,75 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/projects", - "title": "Create a repository project", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/{column_id}/cards", + "title": "Create a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "column_id", + "description": "

The unique identifier of the column.

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

The name of the project.

", + "description": "

The project card's note

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

The unique identifier of the content associated with the card

", "isRequired": true }, { "type": "string", - "name": "body", + "name": "content_type", "in": "body", - "description": "

The description of the project.

" + "description": "

The piece of content associated with the card

", + "isRequired": true } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Create a new card", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site." + "note": "Add payload for delete Project column" }, "parameters": { - "owner": "OWNER", - "repo": "REPO" + "column_id": "COLUMN_ID" } }, "response": { @@ -377996,16 +377206,10 @@ "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -378026,82 +377230,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -378283,43 +377451,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -378328,12 +377512,16 @@ } ], "previews": [], - "descriptionHTML": "

Creates a repository project board. Returns a 410 Gone status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", + "descriptionHTML": "

Create a project card

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

Created

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

Not modified

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

Requires authentication

" @@ -378343,12 +377531,314 @@ "description": "

Forbidden

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

Resource not found

" + "httpStatusCode": "422", + "description": "

Validation failed

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

Gone

" + "httpStatusCode": "503", + "description": "

Service Unavailable

" + } + ] + } + ], + "collaborators": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "title": "List project collaborators", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "outside", + "direct", + "all" + ], + "default": "all" + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "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 + } + ], + "schema": { + "type": "array", + "items": { + "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" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.

", + "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", @@ -378358,55 +377848,254 @@ }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/user/projects", - "title": "Create a user project", - "category": "projects", - "subcategory": "projects", - "parameters": [], + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "title": "Add project collaborator", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

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

Name of the project

", - "isRequired": true + "description": "

The permission to grant the collaborator.

", + "enum": [ + "read", + "write", + "admin" + ], + "default": "write" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Applying write permissions for the new collaborator", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "write" + }, + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

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

Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.

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

No Content

" }, { - "type": "string or null", - "name": "body", - "in": "body", - "description": "

Body of the project

" + "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": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "title": "Remove user as a collaborator", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "204", + "description": "

Response

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

Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.

", + "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

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

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "title": "Get project permission for a user", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", - "description": "Create a new project", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "My Projects", - "body": "A board to manage my personal projects." + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "number": 1, - "state": "open", - "creator": { + "permission": "admin", + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -378425,86 +378114,17 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + } }, "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Collaborator Permission", + "description": "Project Collaborator Permission", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] + "permission": { + "type": "string" }, - "creator": { + "user": { "anyOf": [ { "type": "null" @@ -378678,48 +378298,340 @@ ] } ] + } + }, + "required": [ + "permission", + "user" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.

", + "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.

" + } + ] + } + ], + "columns": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "title": "Get a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "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/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:18:44Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Gets information about a project column.

", + "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": "http(s)://HOSTNAME/api/v3", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "title": "Update an existing project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

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

Name of the project column

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Rename the project column", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "To Do" + }, + "parameters": { + "column_id": "COLUMN_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "project_url": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] } }, "required": [ "id", "node_id", - "number", - "name", - "body", - "state", "url", - "html_url", - "owner_url", - "creator", - "columns_url", + "project_url", + "cards_url", + "name", "created_at", "updated_at" ] @@ -378728,7 +378640,164 @@ } ], "previews": [], - "descriptionHTML": "

Creates a user project board. Returns a 410 Gone status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", + "descriptionHTML": "

Update an existing project column

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

OK

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

Not modified

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

Requires authentication

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

Forbidden

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "title": "Delete a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

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

Response

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

Deletes a project column.

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

No Content

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

Not modified

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

Requires authentication

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

Forbidden

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "title": "Move a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

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

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Move the column to the end of the board", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "position": "last" + }, + "parameters": { + "column_id": "COLUMN_ID" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

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

Move a project column

", "statusCodes": [ { "httpStatusCode": "201", @@ -378755,14 +378824,360 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/users/{username}/projects", - "title": "List user projects", - "category": "projects", + "requestPath": "/projects/{project_id}/columns", + "title": "List project columns", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists the project columns in a project.

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

OK

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

Not modified

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

Requires authentication

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

Forbidden

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "title": "Create a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

Name of the project column

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Remaining tasks" + }, + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Creates a new project column.

", + "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.

" + } + ] + } + ], + "projects": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "title": "List organization projects", + "category": "projects-classic", "subcategory": "projects", "parameters": [ { - "name": "username", - "description": "

The handle for the GitHub user account.

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

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -378804,6 +379219,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -378811,7 +379236,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "username": "USERNAME" + "org": "ORG" } }, "response": { @@ -378820,14 +379245,14 @@ "description": "

Response

", "example": [ { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "creator": { @@ -378850,8 +379275,10 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", + "private": true } ], "schema": { @@ -379135,52 +379562,473 @@ "type": "boolean" } }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - } + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "created_at", + "updated_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "

Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

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

OK

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

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "title": "Create an organization project", + "category": "projects-classic", + "subcategory": "projects", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

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

The name of the project.

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

The description of the project.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year." + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "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": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z" + }, + "schema": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "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": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "created_at", + "updated_at" + ] } } } ], "previews": [], - "descriptionHTML": "

Lists projects for a user.

", + "descriptionHTML": "

Creates an organization project board. Returns a 410 Gone status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

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

OK

" + "httpStatusCode": "201", + "description": "

Created

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

Requires authentication

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

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] - } - ], - "cards": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Get a project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/projects/{project_id}", + "title": "Get a project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "project_id", + "description": "

The unique identifier of the project.

", "in": "path", "required": true, "schema": { @@ -379189,6 +380037,20 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", @@ -379196,7 +380058,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "card_id": "CARD_ID" + "project_id": "PROJECT_ID" } }, "response": { @@ -379204,10 +380066,16 @@ "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", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -379228,46 +380096,82 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -379449,59 +380353,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -379510,7 +380398,7 @@ } ], "previews": [], - "descriptionHTML": "

Gets information about a project card.

", + "descriptionHTML": "

Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", "statusCodes": [ { "httpStatusCode": "200", @@ -379527,24 +380415,20 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "patch", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Update an existing project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/projects/{project_id}", + "title": "Update a project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "project_id", + "description": "

The unique identifier of the project.

", "in": "path", "required": true, "schema": { @@ -379553,31 +380437,70 @@ } ], "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the project

" + }, { "type": "string or null", - "name": "note", + "name": "body", "in": "body", - "description": "

The project card's note

" + "description": "

Body of the project

" + }, + { + "type": "string", + "name": "state", + "in": "body", + "description": "

State of the project; either 'open' or 'closed'

" + }, + { + "type": "string", + "name": "organization_permission", + "in": "body", + "description": "

The baseline permission that all organization members have on this project

", + "enum": [ + "read", + "write", + "admin", + "none" + ] }, { "type": "boolean", - "name": "archived", + "name": "private", "in": "body", - "description": "

Whether or not the card is archived

" + "description": "

Whether or not this project can be seen by everyone.

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Change the note on the card", + "description": "Change the name, state, and permissions for a project", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "note": "Add payload for delete Project column" + "name": "Week One Sprint", + "state": "open", + "organization_permission": "write" }, "parameters": { - "card_id": "CARD_ID" + "project_id": "PROJECT_ID" } }, "response": { @@ -379585,10 +380508,16 @@ "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", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -379609,46 +380538,82 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -379830,59 +380795,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -379891,7 +380840,7 @@ } ], "previews": [], - "descriptionHTML": "", + "descriptionHTML": "

Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", "statusCodes": [ { "httpStatusCode": "200", @@ -379911,7 +380860,11 @@ }, { "httpStatusCode": "404", - "description": "

Resource not found

" + "description": "

Not Found if the authenticated user does not have access to the project

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

Gone

" }, { "httpStatusCode": "422", @@ -379922,14 +380875,14 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "delete", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Delete a project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/projects/{project_id}", + "title": "Delete a project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "project_id", + "description": "

The unique identifier of the project.

", "in": "path", "required": true, "schema": { @@ -379938,6 +380891,19 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "204", @@ -379945,21 +380911,21 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "card_id": "CARD_ID" + "project_id": "PROJECT_ID" } }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

Delete Success

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

Deletes a project card

", + "descriptionHTML": "

Deletes a project board. Returns a 404 Not Found status if projects are disabled.

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

No Content

" + "description": "

Delete Success

" }, { "httpStatusCode": "304", @@ -379976,129 +380942,52 @@ { "httpStatusCode": "404", "description": "

Resource not found

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

Gone

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/columns/cards/{card_id}/moves", - "title": "Move a project card", - "category": "projects", - "subcategory": "cards", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects", + "title": "List repository projects", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "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 - } + "type": "string" } - } - ], - "previews": [], - "descriptionHTML": "", - "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": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "List project cards", - "category": "projects", - "subcategory": "cards", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

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

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

", + "name": "state", + "description": "

Indicates the state of the projects to return.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "all", - "archived", - "not_archived" + "open", + "closed", + "all" ], - "default": "not_archived" + "default": "open" } }, { @@ -380121,6 +381010,17 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", @@ -380128,7 +381028,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "column_id": "COLUMN_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -380137,10 +381038,16 @@ "description": "

Response

", "example": [ { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -380161,49 +381068,85 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" } ], "schema": { "type": "array", "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -380385,59 +381328,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -380447,16 +381374,12 @@ } ], "previews": [], - "descriptionHTML": "

Lists the project cards in a project.

", + "descriptionHTML": "

Lists the projects in a repository. Returns a 404 Not Found status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

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

OK

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

Not modified

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

Requires authentication

" @@ -380464,62 +381387,87 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "Create a project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/repos/{owner}/{repo}/projects", + "title": "Create a repository project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "column_id", - "description": "

The unique identifier of the column.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository without the .git extension. The name is not case sensitive.

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

The project card's note

", - "isRequired": true - }, - { - "type": "integer", - "name": "content_id", + "type": "string", + "name": "name", "in": "body", - "description": "

The unique identifier of the content associated with the card

", + "description": "

The name of the project.

", "isRequired": true }, { "type": "string", - "name": "content_type", + "name": "body", "in": "body", - "description": "

The piece of content associated with the card

", - "isRequired": true + "description": "

The description of the project.

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Create a new card", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "note": "Add payload for delete Project column" + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site." }, "parameters": { - "column_id": "COLUMN_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -380527,10 +381475,16 @@ "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", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -380551,46 +381505,82 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -380772,59 +381762,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -380833,309 +381807,12 @@ } ], "previews": [], - "descriptionHTML": "", + "descriptionHTML": "

Creates a repository project board. Returns a 410 Gone status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

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

Created

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

Not modified

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

Requires authentication

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

Forbidden

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

Validation failed

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

Service Unavailable

" - } - ] - } - ], - "collaborators": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators", - "title": "List project collaborators", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "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": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "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" - ] - } - } - } - } - ], - "previews": [], - "descriptionHTML": "

Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.

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

OK

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

Not modified

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

Requires authentication

" @@ -381148,6 +381825,10 @@ "httpStatusCode": "404", "description": "

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" @@ -381156,215 +381837,61 @@ }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Add project collaborator", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], + "verb": "post", + "requestPath": "/user/projects", + "title": "Create a user project", + "category": "projects-classic", + "subcategory": "projects", + "parameters": [], "bodyParameters": [ { "type": "string", - "name": "permission", + "name": "name", "in": "body", - "description": "

The permission to grant the collaborator.

", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write" - } - ], - "codeExamples": [ - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Applying write permissions for the new collaborator", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "permission": "write" - }, - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" - } - }, - "response": { - "statusCode": "204", - "description": "

Response

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

Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.

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

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Remove user as a collaborator", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

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

Response

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

Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.

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

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "title": "Get project permission for a user", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Name of the project

", + "isRequired": true }, { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "string or null", + "name": "body", + "in": "body", + "description": "

Body of the project

" } ], - "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, "codeExamples": [ { "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Create a new project", "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" + "bodyParameters": { + "name": "My Projects", + "body": "A board to manage my personal projects." } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "permission": "admin", - "user": { + "owner_url": "https://api.github.com/users/octocat", + "url": "https://api.github.com/projects/1002603", + "html_url": "https://github.com/users/octocat/projects/1", + "columns_url": "https://api.github.com/projects/1002603/columns", + "id": 1002603, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "name": "My Projects", + "body": "A board to manage my personal projects.", + "number": 1, + "state": "open", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -381383,17 +381910,86 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } + }, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { - "permission": { - "type": "string" + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] }, - "user": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "creator": { "anyOf": [ { "type": "null" @@ -381567,313 +382163,48 @@ ] } ] - } - }, - "required": [ - "permission", - "user" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.

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

" - } - ] - } - ], - "columns": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/{column_id}", - "title": "Get a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:18:44Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Gets information about a project column.

", - "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": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/projects/columns/{column_id}", - "title": "Update an existing project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

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

Name of the project column

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Rename the project column", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "To Do" - }, - "parameters": { - "column_id": "COLUMN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" + "2014-03-03T18:58:10Z" ] }, - "created_at": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "url", - "project_url", - "cards_url", + "number", "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", "updated_at" ] @@ -381882,138 +382213,7 @@ } ], "previews": [], - "descriptionHTML": "", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "

OK

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

Not modified

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

Requires authentication

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

Forbidden

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/columns/{column_id}", - "title": "Delete a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

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

Response

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

Deletes a project column.

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

No Content

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

Not modified

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

Requires authentication

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

Forbidden

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/columns/{column_id}/moves", - "title": "Move a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

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

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Move the column to the end of the board", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "position": "last" - }, - "parameters": { - "column_id": "COLUMN_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

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

Creates a user project board. Returns a 410 Gone status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", "statusCodes": [ { "httpStatusCode": "201", @@ -382040,18 +382240,33 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/projects/{project_id}/columns", - "title": "List project columns", - "category": "projects", - "subcategory": "columns", + "requestPath": "/users/{username}/projects", + "title": "List user projects", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "project_id", - "description": "

The unique identifier of the project.

", + "name": "username", + "description": "

The handle for the GitHub user account.

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

Indicates the state of the projects to return.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" } }, { @@ -382074,6 +382289,12 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, "codeExamples": [ { "key": "default", @@ -382081,7 +382302,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "project_id": "PROJECT_ID" + "username": "USERNAME" } }, "response": { @@ -382090,86 +382311,333 @@ "description": "

Response

", "example": [ { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" + "owner_url": "https://api.github.com/users/octocat", + "url": "https://api.github.com/projects/1002603", + "html_url": "https://github.com/users/octocat/projects/1", + "columns_url": "https://api.github.com/projects/1002603/columns", + "id": 1002603, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "name": "My Projects", + "body": "A board to manage my personal projects.", + "number": 1, + "state": "open", + "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": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" } ], "schema": { "type": "array", "items": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "https://api.github.com/projects/1002604" ] }, - "project_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://github.com/api-playground/projects-test/projects/12" ] }, - "cards_url": { + "columns_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367/cards" + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The unique identifier of the project column", "type": "integer", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, "name": { - "description": "Name of the project column", + "description": "Name of the project", "type": "string", "examples": [ - "Remaining tasks" + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "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:18:44Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "url", - "project_url", - "cards_url", + "number", "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", "updated_at" ] @@ -382179,175 +382647,12 @@ } ], "previews": [], - "descriptionHTML": "

Lists the project columns in a project.

", + "descriptionHTML": "

Lists projects for a user.

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

OK

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

Not modified

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

Requires authentication

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

Forbidden

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/{project_id}/columns", - "title": "Create a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Name of the project column

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Remaining tasks" - }, - "parameters": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "

Creates a new project column.

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

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

Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.

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

OK

" } - ] + ], + "descriptionHTML": "

Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.

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

Note

\n

\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.

\n
\n

Delete a reaction to 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": "

Note

\n

\nYou can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.

\n
\n

Delete a reaction to a team discussion.

\n

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

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

List any syntax errors that are detected in the CODEOWNERS\nfile.

\n

For more information about the correct CODEOWNERS syntax,\nsee \"About code owners.\"

", "statusCodes": [ { "httpStatusCode": "200", @@ -453613,7 +453917,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

List any syntax errors that are detected in the CODEOWNERS\nfile.

\n

For more information about the correct CODEOWNERS syntax,\nsee \"About code owners.\"

" }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -524686,13 +524991,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 List discussions endpoint.

\n
\n

List all discussions on a team's page.

\n

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

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

OK

" } - ] + ], + "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 List discussions endpoint.

\n
\n

List all discussions on a team's page.

\n

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

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

Lists a connection between a team and an external group.

\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 a connection between a team and an external group.

\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", 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 508395c2dc5c..4401ffb50d41 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 @@ -1364,13 +1364,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists repositories and their GitHub Actions cache usage for an organization.\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

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

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

OK

" } - ], - "descriptionHTML": "

Lists repositories and their GitHub Actions cache usage for an organization.\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

OAuth tokens and personal access tokens (classic) need the read:org 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", @@ -2961,13 +2961,13 @@ } ], "previews": [], + "descriptionHTML": "

Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

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

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

No Content

" } - ], - "descriptionHTML": "

Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise 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", @@ -7574,13 +7574,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

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 admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

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

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 admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" + ] }, { "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", @@ -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", @@ -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", @@ -28755,6 +28755,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists jobs for a specific workflow run attempt. 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", @@ -28764,8 +28765,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Lists jobs for a specific workflow run attempt. 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.

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

Cancels a workflow run using its id.

\n

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

", "statusCodes": [ { "httpStatusCode": "202", @@ -38459,8 +38460,7 @@ "httpStatusCode": "409", "description": "

Conflict

" } - ], - "descriptionHTML": "

Cancels a workflow run using its id.

\n

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

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

The permissions the installation has are included under the permissions key.

\n

You must use a JWT to access this endpoint.

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

The permissions the installation has are included under the permissions key.

" } - ], - "descriptionHTML": "

The permissions the installation has are included under the permissions key.

\n

You must use a JWT to access this endpoint.

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

OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.

", "statusCodes": [ { "httpStatusCode": "204", @@ -108397,8 +108398,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.

" + ] } ], "webhooks": [ @@ -109361,13 +109361,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.

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

Gets a single check suite using its id.

\n

Note

\n

\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\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": "

Gets a single check suite using its id.

\n

Note

\n

\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\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", @@ -160282,7 +160282,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all code security configurations available in an 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 write:org scope to use this endpoint.

\n

Note

\n

\nThe enablement status will only be returned for installed security products.

\n
", + "descriptionHTML": "

Lists all code security configurations available in an 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.

\n

Note

\n

\nThe enablement status will only be returned for installed security products.

\n
", "statusCodes": [ { "httpStatusCode": "200", @@ -160736,13 +160736,13 @@ } ], "previews": [], + "descriptionHTML": "

Creates a code security configuration in an 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 write:org scope to use this endpoint.

\n

Note

\n

\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.

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

Successfully created code security configuration

" } - ], - "descriptionHTML": "

Creates a code security configuration in an 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 write:org scope to use this endpoint.

\n

Note

\n

\nOnly installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.

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

Lists the repositories associated with a code security configuration in an 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 write:org scope to use this endpoint.

", + "descriptionHTML": "

Lists the repositories associated with a code security configuration in an 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", @@ -204627,6 +204627,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists all the emojis available to use on GitHub Enterprise Server.

", "statusCodes": [ { "httpStatusCode": "200", @@ -204636,8 +204637,7 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ], - "descriptionHTML": "

Lists all the emojis available to use on GitHub Enterprise Server.

" + ] } ] }, @@ -205144,13 +205144,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

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

Parameters that are not provided will be overwritten with the default value or removed if no default exists.

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

OK

" } - ], - "descriptionHTML": "

Parameters that are not provided will be overwritten with the default value or removed if no default exists.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -208401,13 +208401,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] } ], "manage-ghes": [ @@ -213677,13 +213677,13 @@ } ], "previews": [], + "descriptionHTML": "

For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement

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

OK

" } - ], - "descriptionHTML": "

For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement

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

Lists personal access tokens for all users, including admin users.

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

OK

" } - ], - "descriptionHTML": "

Lists personal access tokens for all users, including admin users.

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

Checks if a user has permission to be assigned to an issue in this repository.

\n

If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

\n

Otherwise a 404 status code is returned.

", "statusCodes": [ { "httpStatusCode": "204", @@ -263213,8 +263214,7 @@ "httpStatusCode": "404", "description": "

Otherwise a 404 status code is returned.

" } - ], - "descriptionHTML": "

Checks if a user has permission to be assigned to an issue in this repository.

\n

If the assignee can be assigned to issues in the repository, a 204 header with no content is returned.

\n

Otherwise a 404 status code is returned.

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

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n\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 organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n\n

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

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

Gets information about the single most recent build of a GitHub Enterprise Server Pages site.

\n

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

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

OK

" } - ], - "descriptionHTML": "

Gets information about the single most recent build of a GitHub Enterprise Server Pages site.

\n

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

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -379569,489 +379569,60 @@ } ] }, - "projects": { - "projects": [ + "projects-classic": { + "cards": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/orgs/{org}/projects", - "title": "List organization projects", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Get a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "

Indicates the state of the projects to return.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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 + "type": "integer" } } ], "bodyParameters": [], - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": true - } - ], - "schema": { - "type": "array", - "items": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "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": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "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": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/projects", - "title": "Create an organization project", - "category": "projects", - "subcategory": "projects", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" + { + "\"Projects\" organization permissions": "read" } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "

The name of the project.

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

The description of the project.

" - } - ], + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - }, "parameters": { - "org": "ORG" + "card_id": "CARD_ID" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", + "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, @@ -380072,82 +379643,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -380329,437 +379864,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "2016-09-05T14:20:22Z" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "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": "201", - "description": "

Created

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

Requires authentication

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

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}", - "title": "Get a project", - "category": "projects", - "subcategory": "projects", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Response

", - "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", - "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": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - }, - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean", "examples": [ - "https://api.github.com/repos/api-playground/projects-test" + false ] }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] + "column_name": { + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] + "project_id": { + "type": "string" }, - "columns_url": { + "column_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "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" - ] - } + "https://api.github.com/projects/columns/367" ] }, - "created_at": { + "content_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2011-04-10T20:09:31Z" + "https://api.github.com/repos/api-playground/projects-test/issues/3" ] }, - "updated_at": { + "project_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "https://api.github.com/projects/120" ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" } }, "required": [ "id", "node_id", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -380785,20 +379942,24 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "patch", - "requestPath": "/projects/{project_id}", - "title": "Update a project", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Update an existing project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "project_id", - "description": "

The unique identifier of the project.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { @@ -380807,57 +379968,44 @@ } ], "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "

Name of the project

" - }, { "type": "string or null", - "name": "body", - "in": "body", - "description": "

Body of the project

" - }, - { - "type": "string", - "name": "state", - "in": "body", - "description": "

State of the project; either 'open' or 'closed'

" - }, - { - "type": "string", - "name": "organization_permission", + "name": "note", "in": "body", - "description": "

The baseline permission that all organization members have on this project

", - "enum": [ - "read", - "write", - "admin", - "none" - ] + "description": "

The project card's note

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

Whether or not this project can be seen by everyone.

" + "description": "

Whether or not the card is archived

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Change the name, state, and permissions for a project", + "description": "Change the note on the card", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" + "note": "Add payload for delete Project column" }, "parameters": { - "project_id": "PROJECT_ID" + "card_id": "CARD_ID" } }, "response": { @@ -380865,16 +380013,10 @@ "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -380895,82 +380037,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -381152,43 +380258,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -381217,11 +380339,7 @@ }, { "httpStatusCode": "404", - "description": "

Not Found if the authenticated user does not have access to the project

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

Gone

" + "description": "

Resource not found

" }, { "httpStatusCode": "422", @@ -381232,14 +380350,14 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "delete", - "requestPath": "/projects/{project_id}", - "title": "Delete a project", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Delete a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "project_id", - "description": "

The unique identifier of the project.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { @@ -381248,6 +380366,19 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "204", @@ -381255,12 +380386,12 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "project_id": "PROJECT_ID" + "card_id": "CARD_ID" } }, "response": { "statusCode": "204", - "description": "

Delete Success

" + "description": "

Response

" } } ], @@ -381269,7 +380400,7 @@ "statusCodes": [ { "httpStatusCode": "204", - "description": "

Delete Success

" + "description": "

No Content

" }, { "httpStatusCode": "304", @@ -381286,52 +380417,142 @@ { "httpStatusCode": "404", "description": "

Resource not found

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

Gone

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/projects", - "title": "List repository projects", - "category": "projects", - "subcategory": "projects", + "verb": "post", + "requestPath": "/projects/columns/cards/{card_id}/moves", + "title": "Move a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { - "type": "string" + "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 }, { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "type": "integer", + "name": "column_id", + "in": "body", + "description": "

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

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "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": "http(s)://HOSTNAME/api/v3", + "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": "string" + "type": "integer" } }, { - "name": "state", - "description": "

Indicates the state of the projects to return.

", + "name": "archived_state", + "description": "

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

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "open", - "closed", - "all" + "all", + "archived", + "not_archived" ], - "default": "open" + "default": "not_archived" } }, { @@ -381354,6 +380575,20 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", @@ -381361,8 +380596,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "column_id": "COLUMN_ID" } }, "response": { @@ -381371,16 +380605,10 @@ "description": "

Response

", "example": [ { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -381401,85 +380629,49 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -381661,43 +380853,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -381713,6 +380921,10 @@ "httpStatusCode": "200", "description": "

OK

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

Not modified

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

Requires authentication

" @@ -381720,77 +380932,75 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/projects", - "title": "Create a repository project", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/{column_id}/cards", + "title": "Create a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "column_id", + "description": "

The unique identifier of the column.

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

The name of the project.

", + "description": "

The project card's note

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

The unique identifier of the content associated with the card

", "isRequired": true }, { "type": "string", - "name": "body", + "name": "content_type", "in": "body", - "description": "

The description of the project.

" + "description": "

The piece of content associated with the card

", + "isRequired": true } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Create a new card", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site." + "note": "Add payload for delete Project column" }, "parameters": { - "owner": "OWNER", - "repo": "REPO" + "column_id": "COLUMN_ID" } }, "response": { @@ -381798,16 +381008,10 @@ "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -381828,82 +381032,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -382085,43 +381253,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -382136,6 +381320,10 @@ "httpStatusCode": "201", "description": "

Created

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

Not modified

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

Requires authentication

" @@ -382145,12 +381333,314 @@ "description": "

Forbidden

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

Resource not found

" + "httpStatusCode": "422", + "description": "

Validation failed

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

Gone

" + "httpStatusCode": "503", + "description": "

Service Unavailable

" + } + ] + } + ], + "collaborators": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "title": "List project collaborators", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "outside", + "direct", + "all" + ], + "default": "all" + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "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 + } + ], + "schema": { + "type": "array", + "items": { + "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" + ] + } + } + } + } + ], + "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", @@ -382160,55 +381650,254 @@ }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/user/projects", - "title": "Create a user project", - "category": "projects", - "subcategory": "projects", - "parameters": [], + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "title": "Add project collaborator", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

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

Name of the project

", - "isRequired": true + "description": "

The permission to grant the collaborator.

", + "enum": [ + "read", + "write", + "admin" + ], + "default": "write" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Applying write permissions for the new collaborator", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "write" + }, + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "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

" }, { - "type": "string or null", - "name": "body", - "in": "body", - "description": "

Body of the project

" + "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": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "title": "Remove user as a collaborator", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "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

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

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "title": "Get project permission for a user", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", - "description": "Create a new project", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "My Projects", - "body": "A board to manage my personal projects." + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "number": 1, - "state": "open", - "creator": { + "permission": "admin", + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -382227,86 +381916,17 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + } }, "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Collaborator Permission", + "description": "Project Collaborator Permission", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] + "permission": { + "type": "string" }, - "creator": { + "user": { "anyOf": [ { "type": "null" @@ -382480,48 +382100,172 @@ ] } ] + } + }, + "required": [ + "permission", + "user" + ] + } + } + } + ], + "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.

" + } + ] + } + ], + "columns": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "title": "Get a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "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/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] }, - "created_at": { + "project_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2011-04-10T20:09:31Z" + "https://api.github.com/projects/120" ] }, - "updated_at": { + "cards_url": { "type": "string", - "format": "date-time", + "format": "uri", "examples": [ - "2014-03-03T18:58:10Z" + "https://api.github.com/projects/columns/367/cards" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] } }, "required": [ "id", "node_id", - "number", - "name", - "body", - "state", "url", - "html_url", - "owner_url", - "creator", - "columns_url", + "project_url", + "cards_url", + "name", "created_at", "updated_at" ] @@ -382533,8 +382277,8 @@ "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": "200", + "description": "

OK

" }, { "httpStatusCode": "304", @@ -382549,94 +382293,775 @@ "description": "

Forbidden

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

Validation failed, or the endpoint has been spammed.

" + "httpStatusCode": "404", + "description": "

Resource not found

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/users/{username}/projects", - "title": "List user projects", - "category": "projects", - "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "title": "Update an existing project column", + "category": "projects-classic", + "subcategory": "columns", "parameters": [ { - "name": "username", - "description": "

The handle for the GitHub user account.

", + "name": "column_id", + "description": "

The unique identifier of the column.

", "in": "path", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "

Indicates the state of the projects to return.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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 + "type": "integer" } - }, + } + ], + "bodyParameters": [ { - "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 - } + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the project column

", + "isRequired": true } ], - "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Rename the project column", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "To Do" + }, "parameters": { - "username": "USERNAME" + "column_id": "COLUMN_ID" } }, "response": { "statusCode": "200", "contentType": "application/json", "description": "

Response

", - "example": [ - { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "example": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "title": "Delete a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "column_id": "COLUMN_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

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "title": "Move a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

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

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Move the column to the end of the board", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "position": "last" + }, + "parameters": { + "column_id": "COLUMN_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.

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "title": "List project columns", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "title": "Create a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

Name of the project column

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Remaining tasks" + }, + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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": "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.

" + } + ] + } + ], + "projects": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "title": "List organization projects", + "category": "projects-classic", + "subcategory": "projects", + "parameters": [ + { + "name": "org", + "description": "

The organization name. The name is not case sensitive.

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

Indicates the state of the projects to return.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "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", @@ -382652,8 +383077,10 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", + "private": true } ], "schema": { @@ -382969,47 +383396,80 @@ "description": "

Validation failed, or the endpoint has been spammed.

" } ] - } - ], - "cards": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Get a project card", - "category": "projects", - "subcategory": "cards", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "title": "Create an organization project", + "category": "projects-classic", + "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" } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

The name of the project.

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

The description of the project.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year." + }, "parameters": { - "card_id": "CARD_ID" + "org": "ORG" } }, "response": { - "statusCode": "200", + "statusCode": "201", "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", + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -383030,46 +383490,82 @@ "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" + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -383251,59 +383747,451 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:20:22Z" + "2014-03-03T18:58:10Z" ] }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", - "examples": [ - false + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "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": "201", + "description": "

Created

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

Requires authentication

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

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/projects/{project_id}", + "title": "Get a project", + "category": "projects-classic", + "subcategory": "projects", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

Response

", + "example": { + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", + "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": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + }, + "schema": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] }, - "column_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "https://api.github.com/projects/1002604" ] }, - "content_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "https://github.com/api-playground/projects-test/projects/12" ] }, - "project_url": { + "columns_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "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": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -383329,24 +384217,20 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "patch", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Update an existing project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/projects/{project_id}", + "title": "Update a project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "project_id", + "description": "

The unique identifier of the project.

", "in": "path", "required": true, "schema": { @@ -383355,31 +384239,70 @@ } ], "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the project

" + }, { "type": "string or null", - "name": "note", + "name": "body", "in": "body", - "description": "

The project card's note

" + "description": "

Body of the project

" + }, + { + "type": "string", + "name": "state", + "in": "body", + "description": "

State of the project; either 'open' or 'closed'

" + }, + { + "type": "string", + "name": "organization_permission", + "in": "body", + "description": "

The baseline permission that all organization members have on this project

", + "enum": [ + "read", + "write", + "admin", + "none" + ] }, { "type": "boolean", - "name": "archived", + "name": "private", "in": "body", - "description": "

Whether or not the card is archived

" + "description": "

Whether or not this project can be seen by everyone.

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Change the note on the card", + "description": "Change the name, state, and permissions for a project", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "note": "Add payload for delete Project column" + "name": "Week One Sprint", + "state": "open", + "organization_permission": "write" }, "parameters": { - "card_id": "CARD_ID" + "project_id": "PROJECT_ID" } }, "response": { @@ -383387,10 +384310,16 @@ "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", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -383411,46 +384340,82 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -383632,59 +384597,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -383713,7 +384662,11 @@ }, { "httpStatusCode": "404", - "description": "

Resource not found

" + "description": "

Not Found if the authenticated user does not have access to the project

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

Gone

" }, { "httpStatusCode": "422", @@ -383724,14 +384677,14 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "delete", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Delete a project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/projects/{project_id}", + "title": "Delete a project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "project_id", + "description": "

The unique identifier of the project.

", "in": "path", "required": true, "schema": { @@ -383740,6 +384693,19 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "204", @@ -383747,12 +384713,12 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "card_id": "CARD_ID" + "project_id": "PROJECT_ID" } }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

Delete Success

" } } ], @@ -383761,7 +384727,7 @@ "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

Delete Success

" }, { "httpStatusCode": "304", @@ -383778,129 +384744,52 @@ { "httpStatusCode": "404", "description": "

Resource not found

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

Gone

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/columns/cards/{card_id}/moves", - "title": "Move a project card", - "category": "projects", - "subcategory": "cards", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects", + "title": "List repository projects", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "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 - } + "type": "string" } - } - ], - "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": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "List project cards", - "category": "projects", - "subcategory": "cards", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

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

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

", + "name": "state", + "description": "

Indicates the state of the projects to return.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "all", - "archived", - "not_archived" + "open", + "closed", + "all" ], - "default": "not_archived" + "default": "open" } }, { @@ -383923,6 +384812,17 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", @@ -383930,7 +384830,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "column_id": "COLUMN_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -383939,10 +384840,16 @@ "description": "

Response

", "example": [ { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -383963,49 +384870,85 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" } ], "schema": { "type": "array", "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -384187,59 +385130,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -384255,10 +385182,6 @@ "httpStatusCode": "200", "description": "

OK

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

Not modified

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

Requires authentication

" @@ -384266,62 +385189,87 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "Create a project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/repos/{owner}/{repo}/projects", + "title": "Create a repository project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "column_id", - "description": "

The unique identifier of the column.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository without the .git extension. The name is not case sensitive.

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

The project card's note

", - "isRequired": true - }, - { - "type": "integer", - "name": "content_id", + "type": "string", + "name": "name", "in": "body", - "description": "

The unique identifier of the content associated with the card

", + "description": "

The name of the project.

", "isRequired": true }, { "type": "string", - "name": "content_type", + "name": "body", "in": "body", - "description": "

The piece of content associated with the card

", - "isRequired": true + "description": "

The description of the project.

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Create a new card", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "note": "Add payload for delete Project column" + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site." }, "parameters": { - "column_id": "COLUMN_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -384329,10 +385277,16 @@ "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", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -384353,46 +385307,82 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -384574,59 +385564,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -384641,303 +385615,6 @@ "httpStatusCode": "201", "description": "

Created

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

Not modified

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

Requires authentication

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

Forbidden

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

Validation failed

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

Service Unavailable

" - } - ] - } - ], - "collaborators": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators", - "title": "List project collaborators", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "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": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "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" - ] - } - } - } - } - ], - "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

" @@ -384950,6 +385627,10 @@ "httpStatusCode": "404", "description": "

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" @@ -384958,215 +385639,61 @@ }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Add project collaborator", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], + "verb": "post", + "requestPath": "/user/projects", + "title": "Create a user project", + "category": "projects-classic", + "subcategory": "projects", + "parameters": [], "bodyParameters": [ { "type": "string", - "name": "permission", + "name": "name", "in": "body", - "description": "

The permission to grant the collaborator.

", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write" - } - ], - "codeExamples": [ - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Applying write permissions for the new collaborator", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "permission": "write" - }, - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" - } - }, - "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

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Remove user as a collaborator", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" - } - }, - "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

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "title": "Get project permission for a user", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Name of the project

", + "isRequired": true }, { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "string or null", + "name": "body", + "in": "body", + "description": "

Body of the project

" } ], - "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, "codeExamples": [ { "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Create a new project", "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" + "bodyParameters": { + "name": "My Projects", + "body": "A board to manage my personal projects." } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "permission": "admin", - "user": { + "owner_url": "https://api.github.com/users/octocat", + "url": "https://api.github.com/projects/1002603", + "html_url": "https://github.com/users/octocat/projects/1", + "columns_url": "https://api.github.com/projects/1002603/columns", + "id": 1002603, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "name": "My Projects", + "body": "A board to manage my personal projects.", + "number": 1, + "state": "open", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -385185,17 +385712,86 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } + }, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { - "permission": { - "type": "string" + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] }, - "user": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "creator": { "anyOf": [ { "type": "null" @@ -385369,761 +385965,48 @@ ] } ] - } - }, - "required": [ - "permission", - "user" - ] - } - } - } - ], - "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.

" - } - ] - } - ], - "columns": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/{column_id}", - "title": "Get a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:18:44Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "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": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/projects/columns/{column_id}", - "title": "Update an existing project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

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

Name of the project column

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Rename the project column", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "To Do" - }, - "parameters": { - "column_id": "COLUMN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" + "2014-03-03T18:58:10Z" ] }, - "created_at": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "url", - "project_url", - "cards_url", + "number", "name", - "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

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/columns/{column_id}", - "title": "Delete a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "column_id": "COLUMN_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

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/columns/{column_id}/moves", - "title": "Move a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

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

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Move the column to the end of the board", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "position": "last" - }, - "parameters": { - "column_id": "COLUMN_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.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/columns", - "title": "List project columns", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "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

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/{project_id}/columns", - "title": "Create a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Name of the project column

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Remaining tasks" - }, - "parameters": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", + "body", + "state", "url", - "project_url", - "cards_url", - "name", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", "updated_at" ] @@ -386155,6 +386038,428 @@ "description": "

Validation failed, or the endpoint has been spammed.

" } ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/users/{username}/projects", + "title": "List user projects", + "category": "projects-classic", + "subcategory": "projects", + "parameters": [ + { + "name": "username", + "description": "

The handle for the GitHub user account.

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

Indicates the state of the projects to return.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "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": [], + "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": [ + { + "owner_url": "https://api.github.com/users/octocat", + "url": "https://api.github.com/projects/1002603", + "html_url": "https://github.com/users/octocat/projects/1", + "columns_url": "https://api.github.com/projects/1002603/columns", + "id": 1002603, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "name": "My Projects", + "body": "A board to manage my personal projects.", + "number": 1, + "state": "open", + "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": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "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": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "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": "422", + "description": "

Validation failed, or the endpoint has been spammed.

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

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

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

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

OK

" } - ], - "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

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

\n" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -433970,13 +434275,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 reaction for a team discussion comment\" endpoint.

\n
\n

Create a reaction to a team discussion comment.

\n

A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

\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 reaction for a team discussion comment\" endpoint.

\n
\n

Create a reaction to a team discussion comment.

\n

A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

\n

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

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

Lists repositories for the specified organization.

\n

Note

\n

\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

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

OK

" } - ], - "descriptionHTML": "

Lists repositories for the specified organization.

\n

Note

\n

\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

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

Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.

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

OK

" } - ], - "descriptionHTML": "

Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -516392,13 +516697,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", @@ -521738,6 +522043,7 @@ } ], "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 Check team permissions for a repository endpoint.

\n
\n

Note

\n

\nRepositories inherited through a parent team will also be checked.

\n
\n

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:

", "statusCodes": [ { "httpStatusCode": "200", @@ -521751,8 +522057,7 @@ "httpStatusCode": "404", "description": "

Not Found if repository is not managed by this team

" } - ], - "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 Check team permissions for a repository endpoint.

\n
\n

Note

\n

\nRepositories inherited through a parent team will also be checked.

\n
\n

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:

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

Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.

\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": "

Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.

\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", 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 59de575c5327..a9de65514eb8 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 @@ -163696,7 +163696,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all code security configurations available in an 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 write:org scope to use this endpoint.

\n

Note

\n

\nThe enablement status will only be returned for installed security products.

\n
", + "descriptionHTML": "

Lists all code security configurations available in an 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.

\n

Note

\n

\nThe enablement status will only be returned for installed security products.

\n
", "statusCodes": [ { "httpStatusCode": "200", @@ -166704,7 +166704,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the repositories associated with a code security configuration in an 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 write:org scope to use this endpoint.

", + "descriptionHTML": "

Lists the repositories associated with a code security configuration in an 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", @@ -385532,489 +385532,60 @@ } ] }, - "projects": { - "projects": [ + "projects-classic": { + "cards": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/orgs/{org}/projects", - "title": "List organization projects", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Get a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "

Indicates the state of the projects to return.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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 + "type": "integer" } } ], "bodyParameters": [], - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": true - } - ], - "schema": { - "type": "array", - "items": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "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": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "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": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/projects", - "title": "Create an organization project", - "category": "projects", - "subcategory": "projects", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" + { + "\"Projects\" organization permissions": "read" } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "

The name of the project.

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

The description of the project.

" - } - ], + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - }, "parameters": { - "org": "ORG" + "card_id": "CARD_ID" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", + "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, @@ -386035,82 +385606,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -386292,43 +385827,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -386340,8 +385891,12 @@ "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": "200", + "description": "

OK

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

Not modified

" }, { "httpStatusCode": "401", @@ -386354,28 +385909,20 @@ { "httpStatusCode": "404", "description": "

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}", - "title": "Get a project", - "category": "projects", - "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Update an existing project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "project_id", - "description": "

The unique identifier of the project.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { @@ -386383,15 +385930,45 @@ } } ], - "bodyParameters": [], + "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

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { - "description": "Example", + "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": { - "project_id": "PROJECT_ID" + "card_id": "CARD_ID" } }, "response": { @@ -386399,16 +385976,10 @@ "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -386429,82 +386000,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -386686,43 +386221,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -386748,20 +386299,28 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/projects/{project_id}", - "title": "Update a project", - "category": "projects", - "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Delete a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "project_id", - "description": "

The unique identifier of the project.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { @@ -386769,392 +386328,131 @@ } } ], - "bodyParameters": [ + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ { - "type": "string", - "name": "name", - "in": "body", - "description": "

Name of the project

" + "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

" }, { - "type": "string or null", - "name": "body", - "in": "body", - "description": "

Body of the project

" + "httpStatusCode": "304", + "description": "

Not modified

" }, { - "type": "string", - "name": "state", - "in": "body", - "description": "

State of the project; either 'open' or 'closed'

" + "httpStatusCode": "401", + "description": "

Requires authentication

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

Forbidden

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

Resource not found

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "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": "organization_permission", + "name": "position", "in": "body", - "description": "

The baseline permission that all organization members have on this project

", - "enum": [ - "read", - "write", - "admin", - "none" - ] + "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": "boolean", - "name": "private", + "type": "integer", + "name": "column_id", "in": "body", - "description": "

Whether or not this project can be seen by everyone.

" + "description": "

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

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Change the name, state, and permissions for a project", + "description": "Move the card to the bottom of the column", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" + "column_id": 42, + "position": "bottom" }, "parameters": { - "project_id": "PROJECT_ID" + "card_id": "CARD_ID" } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "

Response

", - "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", - "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": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - }, + "example": null, "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "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": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] + "properties": {}, + "additionalProperties": false } } } @@ -387163,8 +386461,8 @@ "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": "201", + "description": "

Created

" }, { "httpStatusCode": "304", @@ -387178,123 +386476,46 @@ "httpStatusCode": "403", "description": "

Forbidden

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

Not Found if the authenticated user does not have access to the project

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

Gone

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/{project_id}", - "title": "Delete a project", - "category": "projects", - "subcategory": "projects", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Delete Success

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

Delete Success

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

Not modified

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

Requires authentication

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

Forbidden

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

Resource not found

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

Gone

" + "httpStatusCode": "503", + "description": "

Service Unavailable

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/projects", - "title": "List repository projects", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/{column_id}/cards", + "title": "List project cards", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "column_id", + "description": "

The unique identifier of the column.

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

Indicates the state of the projects to return.

", + "name": "archived_state", + "description": "

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

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "open", - "closed", - "all" + "all", + "archived", + "not_archived" ], - "default": "open" + "default": "not_archived" } }, { @@ -387317,6 +386538,20 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", @@ -387324,8 +386559,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "column_id": "COLUMN_ID" } }, "response": { @@ -387334,16 +386568,10 @@ "description": "

Response

", "example": [ { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -387364,85 +386592,49 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -387624,43 +386816,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -387676,6 +386884,10 @@ "httpStatusCode": "200", "description": "

OK

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

Not modified

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

Requires authentication

" @@ -387683,77 +386895,75 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/projects", - "title": "Create a repository project", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/{column_id}/cards", + "title": "Create a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "column_id", + "description": "

The unique identifier of the column.

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

The name of the project.

", + "description": "

The project card's note

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

The unique identifier of the content associated with the card

", "isRequired": true }, { "type": "string", - "name": "body", + "name": "content_type", "in": "body", - "description": "

The description of the project.

" + "description": "

The piece of content associated with the card

", + "isRequired": true } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Create a new card", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site." + "note": "Add payload for delete Project column" }, "parameters": { - "owner": "OWNER", - "repo": "REPO" + "column_id": "COLUMN_ID" } }, "response": { @@ -387761,16 +386971,10 @@ "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -387791,82 +386995,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -388048,43 +387216,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -388099,6 +387283,10 @@ "httpStatusCode": "201", "description": "

Created

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

Not modified

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

Requires authentication

" @@ -388108,70 +387296,98 @@ "description": "

Forbidden

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

Resource not found

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

Gone

" + "httpStatusCode": "422", + "description": "

Validation failed

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

Validation failed, or the endpoint has been spammed.

" + "httpStatusCode": "503", + "description": "

Service Unavailable

" } ] - }, + } + ], + "collaborators": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/user/projects", - "title": "Create a user project", - "category": "projects", - "subcategory": "projects", - "parameters": [], - "bodyParameters": [ + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "title": "List project collaborators", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ { - "type": "string", - "name": "name", - "in": "body", - "description": "

Name of the project

", - "isRequired": true + "name": "project_id", + "description": "

The unique identifier of the project.

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

Body of the project

" + "name": "affiliation", + "description": "

Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "outside", + "direct", + "all" + ], + "default": "all" + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", - "description": "Create a new project", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "My Projects", - "body": "A board to manage my personal projects." + "parameters": { + "project_id": "PROJECT_ID" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", - "example": { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "number": 1, - "state": "open", - "creator": { + "example": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -388190,86 +387406,490 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - }, + } + ], "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] + "type": "array", + "items": { + "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" + ] + } }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] + "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" + ] + } + } + } + } + ], + "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": "http(s)://HOSTNAME/api/v3", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "title": "Add project collaborator", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

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

The permission to grant the collaborator.

", + "enum": [ + "read", + "write", + "admin" + ], + "default": "write" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Applying write permissions for the new collaborator", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "write" + }, + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "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

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

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "title": "Remove user as a collaborator", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "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

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

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "title": "Get project permission for a user", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "permission": "admin", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "schema": { + "title": "Project Collaborator Permission", + "description": "Project Collaborator Permission", + "type": "object", + "properties": { + "permission": { + "type": "string" }, - "creator": { + "user": { "anyOf": [ { "type": "null" @@ -388443,48 +388063,340 @@ ] } ] + } + }, + "required": [ + "permission", + "user" + ] + } + } + } + ], + "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.

" + } + ] + } + ], + "columns": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "title": "Get a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "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/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:18:44Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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": "http(s)://HOSTNAME/api/v3", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "title": "Update an existing project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

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

Name of the project column

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Rename the project column", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "To Do" + }, + "parameters": { + "column_id": "COLUMN_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "project_url": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] } }, "required": [ "id", "node_id", - "number", - "name", - "body", - "state", "url", - "html_url", - "owner_url", - "creator", - "columns_url", + "project_url", + "cards_url", + "name", "created_at", "updated_at" ] @@ -388494,6 +388406,163 @@ ], "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

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "title": "Delete a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "column_id": "COLUMN_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

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "title": "Move a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

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

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Move the column to the end of the board", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "position": "last" + }, + "parameters": { + "column_id": "COLUMN_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", @@ -388520,14 +388589,360 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/users/{username}/projects", - "title": "List user projects", - "category": "projects", + "requestPath": "/projects/{project_id}/columns", + "title": "List project columns", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "title": "Create a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

Name of the project column

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Remaining tasks" + }, + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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": "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.

" + } + ] + } + ], + "projects": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "title": "List organization projects", + "category": "projects-classic", "subcategory": "projects", "parameters": [ { - "name": "username", - "description": "

The handle for the GitHub user account.

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

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -388569,6 +388984,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -388576,7 +389001,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "username": "USERNAME" + "org": "ORG" } }, "response": { @@ -388585,14 +389010,14 @@ "description": "

Response

", "example": [ { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "creator": { @@ -388615,8 +389040,10 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", + "private": true } ], "schema": { @@ -388932,47 +389359,80 @@ "description": "

Validation failed, or the endpoint has been spammed.

" } ] - } - ], - "cards": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Get a project card", - "category": "projects", - "subcategory": "cards", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "title": "Create an organization project", + "category": "projects-classic", + "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" } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

The name of the project.

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

The description of the project.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year." + }, "parameters": { - "card_id": "CARD_ID" + "org": "ORG" } }, "response": { - "statusCode": "200", + "statusCode": "201", "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", + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -388993,46 +389453,82 @@ "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" + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -389214,59 +389710,451 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:20:22Z" + "2014-03-03T18:58:10Z" ] }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", - "examples": [ - false + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "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": "201", + "description": "

Created

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

Requires authentication

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

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/projects/{project_id}", + "title": "Get a project", + "category": "projects-classic", + "subcategory": "projects", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

Response

", + "example": { + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", + "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": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + }, + "schema": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] }, - "column_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "https://api.github.com/projects/1002604" ] }, - "content_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "https://github.com/api-playground/projects-test/projects/12" ] }, - "project_url": { + "columns_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "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": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -389292,24 +390180,20 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "patch", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Update an existing project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/projects/{project_id}", + "title": "Update a project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "project_id", + "description": "

The unique identifier of the project.

", "in": "path", "required": true, "schema": { @@ -389318,31 +390202,70 @@ } ], "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the project

" + }, { "type": "string or null", - "name": "note", + "name": "body", "in": "body", - "description": "

The project card's note

" + "description": "

Body of the project

" + }, + { + "type": "string", + "name": "state", + "in": "body", + "description": "

State of the project; either 'open' or 'closed'

" + }, + { + "type": "string", + "name": "organization_permission", + "in": "body", + "description": "

The baseline permission that all organization members have on this project

", + "enum": [ + "read", + "write", + "admin", + "none" + ] }, { "type": "boolean", - "name": "archived", + "name": "private", "in": "body", - "description": "

Whether or not the card is archived

" + "description": "

Whether or not this project can be seen by everyone.

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Change the note on the card", + "description": "Change the name, state, and permissions for a project", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "note": "Add payload for delete Project column" + "name": "Week One Sprint", + "state": "open", + "organization_permission": "write" }, "parameters": { - "card_id": "CARD_ID" + "project_id": "PROJECT_ID" } }, "response": { @@ -389350,10 +390273,16 @@ "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", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -389374,46 +390303,82 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -389595,59 +390560,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "project_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" + "enum": [ + "read", + "write", + "admin", + "none" ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -389676,7 +390625,11 @@ }, { "httpStatusCode": "404", - "description": "

Resource not found

" + "description": "

Not Found if the authenticated user does not have access to the project

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

Gone

" }, { "httpStatusCode": "422", @@ -389687,14 +390640,14 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "delete", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Delete a project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/projects/{project_id}", + "title": "Delete a project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "project_id", + "description": "

The unique identifier of the project.

", "in": "path", "required": true, "schema": { @@ -389703,6 +390656,19 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "204", @@ -389710,12 +390676,12 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "card_id": "CARD_ID" + "project_id": "PROJECT_ID" } }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

Delete Success

" } } ], @@ -389724,7 +390690,7 @@ "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

Delete Success

" }, { "httpStatusCode": "304", @@ -389741,129 +390707,52 @@ { "httpStatusCode": "404", "description": "

Resource not found

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

Gone

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/columns/cards/{card_id}/moves", - "title": "Move a project card", - "category": "projects", - "subcategory": "cards", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects", + "title": "List repository projects", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "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 - } + "type": "string" } - } - ], - "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": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "List project cards", - "category": "projects", - "subcategory": "cards", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

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

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

", + "name": "state", + "description": "

Indicates the state of the projects to return.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "all", - "archived", - "not_archived" + "open", + "closed", + "all" ], - "default": "not_archived" + "default": "open" } }, { @@ -389886,6 +390775,17 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", @@ -389893,7 +390793,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "column_id": "COLUMN_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -389902,10 +390803,16 @@ "description": "

Response

", "example": [ { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -389926,49 +390833,85 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" } ], "schema": { "type": "array", "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -390150,59 +391093,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -390218,10 +391145,6 @@ "httpStatusCode": "200", "description": "

OK

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

Not modified

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

Requires authentication

" @@ -390229,62 +391152,87 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "Create a project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/repos/{owner}/{repo}/projects", + "title": "Create a repository project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "column_id", - "description": "

The unique identifier of the column.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository without the .git extension. The name is not case sensitive.

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

The project card's note

", - "isRequired": true - }, - { - "type": "integer", - "name": "content_id", + "type": "string", + "name": "name", "in": "body", - "description": "

The unique identifier of the content associated with the card

", + "description": "

The name of the project.

", "isRequired": true }, { "type": "string", - "name": "content_type", + "name": "body", "in": "body", - "description": "

The piece of content associated with the card

", - "isRequired": true + "description": "

The description of the project.

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Create a new card", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "note": "Add payload for delete Project column" + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site." }, "parameters": { - "column_id": "COLUMN_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -390292,10 +391240,16 @@ "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", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -390316,46 +391270,82 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -390537,59 +391527,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -390604,303 +391578,6 @@ "httpStatusCode": "201", "description": "

Created

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

Not modified

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

Requires authentication

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

Forbidden

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

Validation failed

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

Service Unavailable

" - } - ] - } - ], - "collaborators": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators", - "title": "List project collaborators", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "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": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "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" - ] - } - } - } - } - ], - "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

" @@ -390913,6 +391590,10 @@ "httpStatusCode": "404", "description": "

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" @@ -390921,215 +391602,61 @@ }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Add project collaborator", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], + "verb": "post", + "requestPath": "/user/projects", + "title": "Create a user project", + "category": "projects-classic", + "subcategory": "projects", + "parameters": [], "bodyParameters": [ { "type": "string", - "name": "permission", + "name": "name", "in": "body", - "description": "

The permission to grant the collaborator.

", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write" - } - ], - "codeExamples": [ - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Applying write permissions for the new collaborator", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "permission": "write" - }, - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" - } - }, - "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

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Remove user as a collaborator", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" - } - }, - "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

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "title": "Get project permission for a user", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Name of the project

", + "isRequired": true }, { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "string or null", + "name": "body", + "in": "body", + "description": "

Body of the project

" } ], - "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, "codeExamples": [ { "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Create a new project", "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" + "bodyParameters": { + "name": "My Projects", + "body": "A board to manage my personal projects." } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "permission": "admin", - "user": { + "owner_url": "https://api.github.com/users/octocat", + "url": "https://api.github.com/projects/1002603", + "html_url": "https://github.com/users/octocat/projects/1", + "columns_url": "https://api.github.com/projects/1002603/columns", + "id": 1002603, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "name": "My Projects", + "body": "A board to manage my personal projects.", + "number": 1, + "state": "open", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -391148,17 +391675,86 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } + }, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { - "permission": { - "type": "string" + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] }, - "user": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "creator": { "anyOf": [ { "type": "null" @@ -391332,313 +391928,48 @@ ] } ] - } - }, - "required": [ - "permission", - "user" - ] - } - } - } - ], - "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.

" - } - ] - } - ], - "columns": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/{column_id}", - "title": "Get a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:18:44Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "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": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/projects/columns/{column_id}", - "title": "Update an existing project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

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

Name of the project column

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Rename the project column", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "To Do" - }, - "parameters": { - "column_id": "COLUMN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" + "2014-03-03T18:58:10Z" ] }, - "created_at": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "url", - "project_url", - "cards_url", + "number", "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", "updated_at" ] @@ -391648,137 +391979,6 @@ ], "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

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/columns/{column_id}", - "title": "Delete a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "column_id": "COLUMN_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

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/columns/{column_id}/moves", - "title": "Move a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

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

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Move the column to the end of the board", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "position": "last" - }, - "parameters": { - "column_id": "COLUMN_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", @@ -391805,18 +392005,33 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/projects/{project_id}/columns", - "title": "List project columns", - "category": "projects", - "subcategory": "columns", + "requestPath": "/users/{username}/projects", + "title": "List user projects", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "project_id", - "description": "

The unique identifier of the project.

", + "name": "username", + "description": "

The handle for the GitHub user account.

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

Indicates the state of the projects to return.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" } }, { @@ -391839,6 +392054,12 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, "codeExamples": [ { "key": "default", @@ -391846,7 +392067,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "project_id": "PROJECT_ID" + "username": "USERNAME" } }, "response": { @@ -391855,86 +392076,333 @@ "description": "

Response

", "example": [ { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" + "owner_url": "https://api.github.com/users/octocat", + "url": "https://api.github.com/projects/1002603", + "html_url": "https://github.com/users/octocat/projects/1", + "columns_url": "https://api.github.com/projects/1002603/columns", + "id": 1002603, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "name": "My Projects", + "body": "A board to manage my personal projects.", + "number": 1, + "state": "open", + "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": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" } ], "schema": { "type": "array", "items": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "https://api.github.com/projects/1002604" ] }, - "project_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://github.com/api-playground/projects-test/projects/12" ] }, - "cards_url": { + "columns_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367/cards" + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The unique identifier of the project column", "type": "integer", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, "name": { - "description": "Name of the project column", + "description": "Name of the project", "type": "string", "examples": [ - "Remaining tasks" + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "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:18:44Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "url", - "project_url", - "cards_url", + "number", "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", "updated_at" ] @@ -391950,169 +392418,6 @@ "httpStatusCode": "200", "description": "

OK

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

Not modified

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

Requires authentication

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

Forbidden

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/{project_id}/columns", - "title": "Create a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Name of the project column

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Remaining tasks" - }, - "parameters": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "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": "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.

" 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 c4ccb58fc296..11a47f4e5d62 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 @@ -164187,7 +164187,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all code security configurations available in an 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 write:org scope to use this endpoint.

\n

Note

\n

\nThe enablement status will only be returned for installed security products.

\n
", + "descriptionHTML": "

Lists all code security configurations available in an 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.

\n

Note

\n

\nThe enablement status will only be returned for installed security products.

\n
", "statusCodes": [ { "httpStatusCode": "200", @@ -167349,7 +167349,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the repositories associated with a code security configuration in an 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 write:org scope to use this endpoint.

", + "descriptionHTML": "

Lists the repositories associated with a code security configuration in an 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", @@ -387849,489 +387849,60 @@ } ] }, - "projects": { - "projects": [ + "projects-classic": { + "cards": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/orgs/{org}/projects", - "title": "List organization projects", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Get a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "state", - "description": "

Indicates the state of the projects to return.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "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 + "type": "integer" } } ], "bodyParameters": [], - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" - } + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": true - } - ], - "schema": { - "type": "array", - "items": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "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": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "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": "422", - "description": "

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/orgs/{org}/projects", - "title": "Create an organization project", - "category": "projects", - "subcategory": "projects", - "parameters": [ - { - "name": "org", - "description": "

The organization name. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" + { + "\"Projects\" organization permissions": "read" } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "

The name of the project.

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

The description of the project.

" - } - ], + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - }, "parameters": { - "org": "ORG" + "card_id": "CARD_ID" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", + "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, @@ -388352,82 +387923,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -388609,43 +388144,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -388657,8 +388208,12 @@ "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": "200", + "description": "

OK

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

Not modified

" }, { "httpStatusCode": "401", @@ -388671,28 +388226,20 @@ { "httpStatusCode": "404", "description": "

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}", - "title": "Get a project", - "category": "projects", - "subcategory": "projects", + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Update an existing project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "project_id", - "description": "

The unique identifier of the project.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { @@ -388700,15 +388247,45 @@ } } ], - "bodyParameters": [], + "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

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { - "description": "Example", + "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": { - "project_id": "PROJECT_ID" + "card_id": "CARD_ID" } }, "response": { @@ -388716,16 +388293,10 @@ "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -388746,82 +388317,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -389003,43 +388538,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -389065,20 +388616,28 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/projects/{project_id}", - "title": "Update a project", - "category": "projects", - "subcategory": "projects", + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "title": "Delete a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "project_id", - "description": "

The unique identifier of the project.

", + "name": "card_id", + "description": "

The unique identifier of the card.

", "in": "path", "required": true, "schema": { @@ -389086,392 +388645,131 @@ } } ], - "bodyParameters": [ + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ { - "type": "string", - "name": "name", - "in": "body", - "description": "

Name of the project

" + "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

" }, { - "type": "string or null", - "name": "body", - "in": "body", - "description": "

Body of the project

" + "httpStatusCode": "304", + "description": "

Not modified

" }, { - "type": "string", - "name": "state", - "in": "body", - "description": "

State of the project; either 'open' or 'closed'

" + "httpStatusCode": "401", + "description": "

Requires authentication

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

Forbidden

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

Resource not found

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "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": "organization_permission", + "name": "position", "in": "body", - "description": "

The baseline permission that all organization members have on this project

", - "enum": [ - "read", - "write", - "admin", - "none" - ] + "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": "boolean", - "name": "private", + "type": "integer", + "name": "column_id", "in": "body", - "description": "

Whether or not this project can be seen by everyone.

" + "description": "

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

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Change the name, state, and permissions for a project", + "description": "Move the card to the bottom of the column", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Week One Sprint", - "state": "open", - "organization_permission": "write" + "column_id": 42, + "position": "bottom" }, "parameters": { - "project_id": "PROJECT_ID" + "card_id": "CARD_ID" } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "

Response

", - "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", - "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": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - }, + "example": null, "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "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": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] + "properties": {}, + "additionalProperties": false } } } @@ -389480,8 +388778,8 @@ "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": "201", + "description": "

Created

" }, { "httpStatusCode": "304", @@ -389495,123 +388793,46 @@ "httpStatusCode": "403", "description": "

Forbidden

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

Not Found if the authenticated user does not have access to the project

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

Gone

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/{project_id}", - "title": "Delete a project", - "category": "projects", - "subcategory": "projects", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Delete Success

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

Delete Success

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

Not modified

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

Requires authentication

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

Forbidden

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

Resource not found

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

Gone

" + "httpStatusCode": "503", + "description": "

Service Unavailable

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/repos/{owner}/{repo}/projects", - "title": "List repository projects", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/{column_id}/cards", + "title": "List project cards", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "column_id", + "description": "

The unique identifier of the column.

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

Indicates the state of the projects to return.

", + "name": "archived_state", + "description": "

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

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "open", - "closed", - "all" + "all", + "archived", + "not_archived" ], - "default": "open" + "default": "not_archived" } }, { @@ -389634,6 +388855,20 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", @@ -389641,8 +388876,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO" + "column_id": "COLUMN_ID" } }, "response": { @@ -389651,16 +388885,10 @@ "description": "

Response

", "example": [ { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -389681,85 +388909,49 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -389941,43 +389133,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -389993,6 +389201,10 @@ "httpStatusCode": "200", "description": "

OK

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

Not modified

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

Requires authentication

" @@ -390000,77 +389212,75 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/repos/{owner}/{repo}/projects", - "title": "Create a repository project", - "category": "projects", - "subcategory": "projects", + "requestPath": "/projects/columns/{column_id}/cards", + "title": "Create a project card", + "category": "projects-classic", + "subcategory": "cards", "parameters": [ { - "name": "owner", - "description": "

The account owner of the repository. The name is not case sensitive.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "name": "column_id", + "description": "

The unique identifier of the column.

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

The name of the project.

", + "description": "

The project card's note

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

The unique identifier of the content associated with the card

", "isRequired": true }, { "type": "string", - "name": "body", + "name": "content_type", "in": "body", - "description": "

The description of the project.

" + "description": "

The piece of content associated with the card

", + "isRequired": true } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Create a new card", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site." + "note": "Add payload for delete Project column" }, "parameters": { - "owner": "OWNER", - "repo": "REPO" + "column_id": "COLUMN_ID" } }, "response": { @@ -390078,16 +389288,10 @@ "contentType": "application/json", "description": "

Response

", "example": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "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, @@ -390108,82 +389312,46 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "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", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" + "https://api.github.com/projects/columns/cards/1478" ] }, "id": { + "description": "The project card's ID", "type": "integer", + "format": "int64", "examples": [ - 1002604 + 42 ] }, "node_id": { "type": "string", "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" + "MDExOlByb2plY3RDYXJkMTQ3OA==" ] }, - "body": { - "description": "Body of the project", + "note": { "type": [ "string", "null" ], "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" + "Add payload for delete Project column" ] }, "creator": { @@ -390365,43 +389533,59 @@ "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:21:06Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:20:22Z" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "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", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "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", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -390416,6 +389600,10 @@ "httpStatusCode": "201", "description": "

Created

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

Not modified

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

Requires authentication

" @@ -390425,70 +389613,98 @@ "description": "

Forbidden

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

Resource not found

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

Gone

" + "httpStatusCode": "422", + "description": "

Validation failed

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

Validation failed, or the endpoint has been spammed.

" + "httpStatusCode": "503", + "description": "

Service Unavailable

" } ] - }, + } + ], + "collaborators": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/user/projects", - "title": "Create a user project", - "category": "projects", - "subcategory": "projects", - "parameters": [], - "bodyParameters": [ + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators", + "title": "List project collaborators", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ { - "type": "string", - "name": "name", - "in": "body", - "description": "

Name of the project

", - "isRequired": true + "name": "project_id", + "description": "

The unique identifier of the project.

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

Body of the project

" + "name": "affiliation", + "description": "

Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "outside", + "direct", + "all" + ], + "default": "all" + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", - "description": "Create a new project", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "My Projects", - "body": "A board to manage my personal projects." + "parameters": { + "project_id": "PROJECT_ID" } }, "response": { - "statusCode": "201", + "statusCode": "200", "contentType": "application/json", "description": "

Response

", - "example": { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", - "number": 1, - "state": "open", - "creator": { + "example": [ + { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -390507,86 +389723,490 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" - }, + } + ], "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] + "type": "array", + "items": { + "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" + ] + } }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] + "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" + ] + } + } + } + } + ], + "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": "http(s)://HOSTNAME/api/v3", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "title": "Add project collaborator", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

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

The permission to grant the collaborator.

", + "enum": [ + "read", + "write", + "admin" + ], + "default": "write" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Applying write permissions for the new collaborator", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "write" + }, + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "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

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

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "title": "Remove user as a collaborator", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "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

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

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "title": "Get project permission for a user", + "category": "projects-classic", + "subcategory": "collaborators", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "admin" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "permission": "admin", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "schema": { + "title": "Project Collaborator Permission", + "description": "Project Collaborator Permission", + "type": "object", + "properties": { + "permission": { + "type": "string" }, - "creator": { + "user": { "anyOf": [ { "type": "null" @@ -390760,48 +390380,340 @@ ] } ] + } + }, + "required": [ + "permission", + "user" + ] + } + } + } + ], + "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.

" + } + ] + } + ], + "columns": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/projects/columns/{column_id}", + "title": "Get a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "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/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2011-04-10T20:09:31Z" + "2016-09-05T14:18:44Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2014-03-03T18:58:10Z" + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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": "http(s)://HOSTNAME/api/v3", + "verb": "patch", + "requestPath": "/projects/columns/{column_id}", + "title": "Update an existing project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

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

Name of the project column

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Rename the project column", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "To Do" + }, + "parameters": { + "column_id": "COLUMN_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" ] }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "project_url": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] } }, "required": [ "id", "node_id", - "number", - "name", - "body", - "state", "url", - "html_url", - "owner_url", - "creator", - "columns_url", + "project_url", + "cards_url", + "name", "created_at", "updated_at" ] @@ -390811,6 +390723,163 @@ ], "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

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/projects/columns/{column_id}", + "title": "Delete a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "204", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "column_id": "COLUMN_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

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "title": "Move a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "column_id", + "description": "

The unique identifier of the column.

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

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Move the column to the end of the board", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "position": "last" + }, + "parameters": { + "column_id": "COLUMN_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", @@ -390837,14 +390906,360 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/users/{username}/projects", - "title": "List user projects", - "category": "projects", + "requestPath": "/projects/{project_id}/columns", + "title": "List project columns", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "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": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + }, + { + "\"Projects\" organization permissions": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": [ + { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/projects/{project_id}/columns", + "title": "Create a project column", + "category": "projects-classic", + "subcategory": "columns", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

Name of the project column

", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Remaining tasks" + }, + "parameters": { + "project_id": "PROJECT_ID" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "

Response

", + "example": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + }, + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367" + ] + }, + "project_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/120" + ] + }, + "cards_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/columns/367/cards" + ] + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEzOlByb2plY3RDb2x1bW4zNjc=" + ] + }, + "name": { + "description": "Name of the project column", + "type": "string", + "examples": [ + "Remaining tasks" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:18:44Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2016-09-05T14:22:28Z" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "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": "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.

" + } + ] + } + ], + "projects": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "title": "List organization projects", + "category": "projects-classic", "subcategory": "projects", "parameters": [ { - "name": "username", - "description": "

The handle for the GitHub user account.

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

The organization name. The name is not case sensitive.

", "in": "path", "required": true, "schema": { @@ -390886,6 +391301,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -390893,7 +391318,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "username": "USERNAME" + "org": "ORG" } }, "response": { @@ -390902,14 +391327,14 @@ "description": "

Response

", "example": [ { - "owner_url": "https://api.github.com/users/octocat", - "url": "https://api.github.com/projects/1002603", - "html_url": "https://github.com/users/octocat/projects/1", - "columns_url": "https://api.github.com/projects/1002603/columns", - "id": 1002603, - "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", - "name": "My Projects", - "body": "A board to manage my personal projects.", + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", "number": 1, "state": "open", "creator": { @@ -390932,8 +391357,10 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", + "private": true } ], "schema": { @@ -391249,47 +391676,80 @@ "description": "

Validation failed, or the endpoint has been spammed.

" } ] - } - ], - "cards": [ + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Get a project card", - "category": "projects", - "subcategory": "cards", + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "title": "Create an organization project", + "category": "projects-classic", + "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" } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

The name of the project.

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

The description of the project.

" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year." + }, "parameters": { - "card_id": "CARD_ID" + "org": "ORG" } }, "response": { - "statusCode": "200", + "statusCode": "201", "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", + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -391310,46 +391770,82 @@ "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" + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -391531,59 +392027,451 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:20:22Z" + "2014-03-03T18:58:10Z" ] }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", - "examples": [ - false + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "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": "201", + "description": "

Created

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

Requires authentication

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

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/projects/{project_id}", + "title": "Get a project", + "category": "projects-classic", + "subcategory": "projects", + "parameters": [ + { + "name": "project_id", + "description": "

The unique identifier of the project.

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

Response

", + "example": { + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", + "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": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + }, + "schema": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] }, - "column_url": { + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "https://api.github.com/projects/1002604" ] }, - "content_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "https://github.com/api-playground/projects-test/projects/12" ] }, - "project_url": { + "columns_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "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": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -391609,24 +392497,20 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "patch", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Update an existing project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/projects/{project_id}", + "title": "Update a project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "project_id", + "description": "

The unique identifier of the project.

", "in": "path", "required": true, "schema": { @@ -391635,31 +392519,70 @@ } ], "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "

Name of the project

" + }, { "type": "string or null", - "name": "note", + "name": "body", "in": "body", - "description": "

The project card's note

" + "description": "

Body of the project

" + }, + { + "type": "string", + "name": "state", + "in": "body", + "description": "

State of the project; either 'open' or 'closed'

" + }, + { + "type": "string", + "name": "organization_permission", + "in": "body", + "description": "

The baseline permission that all organization members have on this project

", + "enum": [ + "read", + "write", + "admin", + "none" + ] }, { "type": "boolean", - "name": "archived", + "name": "private", "in": "body", - "description": "

Whether or not the card is archived

" + "description": "

Whether or not this project can be seen by everyone.

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Change the note on the card", + "description": "Change the name, state, and permissions for a project", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "note": "Add payload for delete Project column" + "name": "Week One Sprint", + "state": "open", + "organization_permission": "write" }, "parameters": { - "card_id": "CARD_ID" + "project_id": "PROJECT_ID" } }, "response": { @@ -391667,10 +392590,16 @@ "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", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -391691,46 +392620,82 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -391912,59 +392877,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "project_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" + "enum": [ + "read", + "write", + "admin", + "none" ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -391993,7 +392942,11 @@ }, { "httpStatusCode": "404", - "description": "

Resource not found

" + "description": "

Not Found if the authenticated user does not have access to the project

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

Gone

" }, { "httpStatusCode": "422", @@ -392004,14 +392957,14 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "delete", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Delete a project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/projects/{project_id}", + "title": "Delete a project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "project_id", + "description": "

The unique identifier of the project.

", "in": "path", "required": true, "schema": { @@ -392020,6 +392973,19 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + }, + { + "\"Projects\" organization permissions": "write" + } + ] + }, "codeExamples": [ { "key": "204", @@ -392027,12 +392993,12 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "card_id": "CARD_ID" + "project_id": "PROJECT_ID" } }, "response": { "statusCode": "204", - "description": "

Response

" + "description": "

Delete Success

" } } ], @@ -392041,7 +393007,7 @@ "statusCodes": [ { "httpStatusCode": "204", - "description": "

No Content

" + "description": "

Delete Success

" }, { "httpStatusCode": "304", @@ -392058,129 +393024,52 @@ { "httpStatusCode": "404", "description": "

Resource not found

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

Gone

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/columns/cards/{card_id}/moves", - "title": "Move a project card", - "category": "projects", - "subcategory": "cards", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/projects", + "title": "List repository projects", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "card_id", - "description": "

The unique identifier of the card.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", "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 - } + "type": "string" } - } - ], - "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": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "List project cards", - "category": "projects", - "subcategory": "cards", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

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

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

", + "name": "state", + "description": "

Indicates the state of the projects to return.

", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "all", - "archived", - "not_archived" + "open", + "closed", + "all" ], - "default": "not_archived" + "default": "open" } }, { @@ -392203,6 +393092,17 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "read" + } + ], + "allowsPublicRead": true + }, "codeExamples": [ { "key": "default", @@ -392210,7 +393110,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "column_id": "COLUMN_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -392219,10 +393120,16 @@ "description": "

Response

", "example": [ { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -392243,49 +393150,85 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" } ], "schema": { "type": "array", "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -392467,59 +393410,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -392535,10 +393462,6 @@ "httpStatusCode": "200", "description": "

OK

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

Not modified

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

Requires authentication

" @@ -392546,62 +393469,87 @@ { "httpStatusCode": "403", "description": "

Forbidden

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

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" } ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "Create a project card", - "category": "projects", - "subcategory": "cards", + "requestPath": "/repos/{owner}/{repo}/projects", + "title": "Create a repository project", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "column_id", - "description": "

The unique identifier of the column.

", + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

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

The name of the repository without the .git extension. The name is not case sensitive.

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

The project card's note

", - "isRequired": true - }, - { - "type": "integer", - "name": "content_id", + "type": "string", + "name": "name", "in": "body", - "description": "

The unique identifier of the content associated with the card

", + "description": "

The name of the project.

", "isRequired": true }, { "type": "string", - "name": "content_type", + "name": "body", "in": "body", - "description": "

The piece of content associated with the card

", - "isRequired": true + "description": "

The description of the project.

" } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" repository permissions": "write" + } + ] + }, "codeExamples": [ { "key": "default", "request": { "contentType": "application/json", - "description": "Create a new card", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { - "note": "Add payload for delete Project column" + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site." }, "parameters": { - "column_id": "COLUMN_ID" + "owner": "OWNER", + "repo": "REPO" } }, "response": { @@ -392609,10 +393557,16 @@ "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", + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", "creator": { "login": "octocat", "id": 1, @@ -392633,46 +393587,82 @@ "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" + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/cards/1478" + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The project card's ID", "type": "integer", - "format": "int64", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "note": { + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", "type": [ "string", "null" ], "examples": [ - "Add payload for delete Project column" + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" ] }, "creator": { @@ -392854,59 +393844,43 @@ "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:21:06Z" + "2011-04-10T20:09:31Z" ] }, "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" + "2014-03-03T18:58:10Z" ] }, - "content_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "note", + "number", + "name", + "body", + "state", "url", - "column_url", - "project_url", + "html_url", + "owner_url", "creator", + "columns_url", "created_at", "updated_at" ] @@ -392921,303 +393895,6 @@ "httpStatusCode": "201", "description": "

Created

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

Not modified

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

Requires authentication

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

Forbidden

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

Validation failed

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

Service Unavailable

" - } - ] - } - ], - "collaborators": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators", - "title": "List project collaborators", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.

", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "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": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": [ - { - "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 - } - ], - "schema": { - "type": "array", - "items": { - "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" - ] - } - } - } - } - ], - "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

" @@ -393230,6 +393907,10 @@ "httpStatusCode": "404", "description": "

Resource not found

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

Gone

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

Validation failed, or the endpoint has been spammed.

" @@ -393238,215 +393919,61 @@ }, { "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Add project collaborator", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], + "verb": "post", + "requestPath": "/user/projects", + "title": "Create a user project", + "category": "projects-classic", + "subcategory": "projects", + "parameters": [], "bodyParameters": [ { "type": "string", - "name": "permission", + "name": "name", "in": "body", - "description": "

The permission to grant the collaborator.

", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write" - } - ], - "codeExamples": [ - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Applying write permissions for the new collaborator", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "permission": "write" - }, - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" - } - }, - "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

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Remove user as a collaborator", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" - } - }, - "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

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

Validation failed, or the endpoint has been spammed.

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "title": "Get project permission for a user", - "category": "projects", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Name of the project

", + "isRequired": true }, { - "name": "username", - "description": "

The handle for the GitHub user account.

", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "string or null", + "name": "body", + "in": "body", + "description": "

Body of the project

" } ], - "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, "codeExamples": [ { "key": "default", "request": { - "description": "Example", + "contentType": "application/json", + "description": "Create a new project", "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_id": "PROJECT_ID", - "username": "USERNAME" + "bodyParameters": { + "name": "My Projects", + "body": "A board to manage my personal projects." } }, "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "

Response

", "example": { - "permission": "admin", - "user": { + "owner_url": "https://api.github.com/users/octocat", + "url": "https://api.github.com/projects/1002603", + "html_url": "https://github.com/users/octocat/projects/1", + "columns_url": "https://api.github.com/projects/1002603/columns", + "id": 1002603, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "name": "My Projects", + "body": "A board to manage my personal projects.", + "number": 1, + "state": "open", + "creator": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -393465,17 +393992,86 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - } + }, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" }, "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { - "permission": { - "type": "string" + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] }, - "user": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/api-playground/projects-test/projects/12" + ] + }, + "columns_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/projects/1002604/columns" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6UHJvamVjdDEwMDI2MDQ=" + ] + }, + "name": { + "description": "Name of the project", + "type": "string", + "examples": [ + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "creator": { "anyOf": [ { "type": "null" @@ -393649,313 +394245,48 @@ ] } ] - } - }, - "required": [ - "permission", - "user" - ] - } - } - } - ], - "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.

" - } - ] - } - ], - "columns": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/{column_id}", - "title": "Get a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "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/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] }, "created_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:18:44Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "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": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/projects/columns/{column_id}", - "title": "Update an existing project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

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

Name of the project column

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Rename the project column", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "To Do" - }, - "parameters": { - "column_id": "COLUMN_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" + "2014-03-03T18:58:10Z" ] }, - "created_at": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "url", - "project_url", - "cards_url", + "number", "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", "updated_at" ] @@ -393965,137 +394296,6 @@ ], "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

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/columns/{column_id}", - "title": "Delete a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "codeExamples": [ - { - "key": "204", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "column_id": "COLUMN_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

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/columns/{column_id}/moves", - "title": "Move a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "

The unique identifier of the column.

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

The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Move the column to the end of the board", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "position": "last" - }, - "parameters": { - "column_id": "COLUMN_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", @@ -394122,18 +394322,33 @@ { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", - "requestPath": "/projects/{project_id}/columns", - "title": "List project columns", - "category": "projects", - "subcategory": "columns", + "requestPath": "/users/{username}/projects", + "title": "List user projects", + "category": "projects-classic", + "subcategory": "projects", "parameters": [ { - "name": "project_id", - "description": "

The unique identifier of the project.

", + "name": "username", + "description": "

The handle for the GitHub user account.

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

Indicates the state of the projects to return.

", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" } }, { @@ -394156,6 +394371,12 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + }, "codeExamples": [ { "key": "default", @@ -394163,7 +394384,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "project_id": "PROJECT_ID" + "username": "USERNAME" } }, "response": { @@ -394172,86 +394393,333 @@ "description": "

Response

", "example": [ { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" + "owner_url": "https://api.github.com/users/octocat", + "url": "https://api.github.com/projects/1002603", + "html_url": "https://github.com/users/octocat/projects/1", + "columns_url": "https://api.github.com/projects/1002603/columns", + "id": 1002603, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "name": "My Projects", + "body": "A board to manage my personal projects.", + "number": 1, + "state": "open", + "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": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" } ], "schema": { "type": "array", "items": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/api-playground/projects-test" + ] + }, "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "https://api.github.com/projects/1002604" ] }, - "project_url": { + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://github.com/api-playground/projects-test/projects/12" ] }, - "cards_url": { + "columns_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367/cards" + "https://api.github.com/projects/1002604/columns" ] }, "id": { - "description": "The unique identifier of the project column", "type": "integer", "examples": [ - 42 + 1002604 ] }, "node_id": { "type": "string", "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, "name": { - "description": "Name of the project column", + "description": "Name of the project", "type": "string", "examples": [ - "Remaining tasks" + "Week One Sprint" + ] + }, + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], + "examples": [ + "This project represents the sprint of the first week in January" + ] + }, + "number": { + "type": "integer", + "examples": [ + 1 + ] + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "examples": [ + "open" + ] + }, + "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:18:44Z" + "2011-04-10T20:09:31Z" ] }, "updated_at": { "type": "string", "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" + "2014-03-03T18:58:10Z" + ] + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "url", - "project_url", - "cards_url", + "number", "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", "updated_at" ] @@ -394267,169 +394735,6 @@ "httpStatusCode": "200", "description": "

OK

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

Not modified

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

Requires authentication

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

Forbidden

" - } - ] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/{project_id}/columns", - "title": "Create a project column", - "category": "projects", - "subcategory": "columns", - "parameters": [ - { - "name": "project_id", - "description": "

The unique identifier of the project.

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

Name of the project column

", - "isRequired": true - } - ], - "codeExamples": [ - { - "key": "default", - "request": { - "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "name": "Remaining tasks" - }, - "parameters": { - "project_id": "PROJECT_ID" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "

Response

", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "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": "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.

" diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 0c055e7e0ad3..f337a05ee2ef 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -44,5 +44,5 @@ ] } }, - "sha": "2c7afd9c1987eeb90da554f9bf12df48ca88ba33" + "sha": "1a8e746d3e6e8faaef13ee92434686571cccb992" } \ No newline at end of file diff --git a/src/types.ts b/src/types.ts index 1f78aa94c714..d624ab9ea503 100644 --- a/src/types.ts +++ b/src/types.ts @@ -471,4 +471,6 @@ export type MarkdownFrontmatter = { versions: FrontmatterVersions subcategory?: boolean hidden?: boolean + type?: string + contentType?: string } diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index f634ebaf72d8..1b14ce565696 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "2c7afd9c1987eeb90da554f9bf12df48ca88ba33" + "sha": "1a8e746d3e6e8faaef13ee92434686571cccb992" } \ No newline at end of file diff --git a/src/workflows/fm-utils.ts b/src/workflows/fm-utils.ts index 7a1d6c8fb979..b6d39e53ce4e 100644 --- a/src/workflows/fm-utils.ts +++ b/src/workflows/fm-utils.ts @@ -8,7 +8,7 @@ export function checkContentType(filePaths: string[], type: string) { const unallowedChangedFiles = [] for (const filePath of filePaths) { const { data } = matter(readFileSync(filePath, 'utf8')) - if (data.type === type) { + if (data.type === type || data.contentType === type) { unallowedChangedFiles.push(filePath) } } diff --git a/src/workflows/unallowed-contributions.ts b/src/workflows/unallowed-contributions.ts index 39a865405297..526774aa0dba 100755 --- a/src/workflows/unallowed-contributions.ts +++ b/src/workflows/unallowed-contributions.ts @@ -46,7 +46,7 @@ async function main() { const listUnallowedChangedFiles = unallowedChangedFiles.map((file) => `\n - ${file}`).join('') const listUnallowedFiles = filters.notAllowed.map((file: string) => `\n - ${file}`).join('') - const reviewMessage = `👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions:${listUnallowedChangedFiles}\n\nYou'll need to revert all of the files you changed that match that list using [GitHub Desktop](https://docs.github.com/en/free-pro-team@latest/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/reverting-a-commit-in-github-desktop) or \`git checkout origin/main \`. Once you get those files reverted, we can continue with the review process. :octocat:\n\nThe complete list of files we can't accept are:${listUnallowedFiles}\n\nWe also can't accept contributions to files in the content directory with frontmatter \`type: rai\`.` + const reviewMessage = `👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions:${listUnallowedChangedFiles}\n\nYou'll need to revert all of the files you changed that match that list using [GitHub Desktop](https://docs.github.com/en/free-pro-team@latest/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/reverting-a-commit-in-github-desktop) or \`git checkout origin/main \`. Once you get those files reverted, we can continue with the review process. :octocat:\n\nThe complete list of files we can't accept are:${listUnallowedFiles}\n\nWe also can't accept contributions to files in the content directory with frontmatter \`type: rai\` or \`contentType: rai\`.` let workflowFailMessage = "It looks like you've modified some files that we can't accept as contributions." pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy