Packages

@octokit/openapi-types

29.0.1 · 29 Aug 2026MIT97.2M / weekRepositoryHomepagenpmAtom feed

Your version

14.0.0

major27 Sep 2022Where it was published

In short

1 breaking15 new6 fixed

  • Breaking

    Types for API operations only available to GitHub Enterprise Cloud (GHEC) customers will no longer appear in the @octokit/openapi-types package. These will only appear in the GHEC-specific @octokit/openapi-types-ghec package. The @octokit/openapi-types package now only includes APIs available to customers on GitHub.com using the Free, Pro and Teams plans.

Release note

Breaking changes

  • Breaking

    Types for API operations only available to GitHub Enterprise Cloud (GHEC) customers will no longer appear in the @octokit/openapi-types package. These will only appear in the GHEC-specific @octokit/openapi-types-ghec package. The @octokit/openapi-types package now only includes APIs available to customers on GitHub.com using the Free, Pro and Teams plans.

Features

  • Publish new GitHub Enterprise Cloud (GHEC) specific @octokit/openapi-types-ghec package, plus lots of API changes

  • Add support for new "Get a Dependabot alert" API (GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number})

  • Add support for new "Update a Dependabot alert" API (PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number})

  • Add support for new "List Dependabot alerts for a repository" API (GET /repos/{owner}/{repo}/dependabot/alerts)

    • feat: add support for new "List organization secret" (GET /organizations/{org}/codespaces/secrets) Codespaces API

  • Add support for new "Get an organization public key" (GET /organizations/{org}/codespaces/secrets/public-key) Codespaces API

  • Add support for new "Get an organization secret" (GET /organizations/{org}/codespaces/secrets/{secret_name} ) Codespaces API

  • Adds support for new "Create or update an organization secret" (PUT /organizations/{org}/codespaces/secrets/{secret_name} ) Codespaces API

  • Add support for new "Delete an organization secret" (DELETE /organizations/{org}/codespaces/secrets/{secret_name}) Codespaces API

  • Add support for new "List selected repositories for an organization secret" (GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories) Codespaces API

  • Add support for new "Set selected repositories for an organization secret" ( PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories) Codespaces API

  • Add support for new "Add selected repository to an organization secret" (PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}) Codespaces API

  • Add support for new "Remove selected repository from an organization secret" (DELETE /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}) Codespaces API

  • Add support for resolution_comment attribute returned on secret scanning alerts

  • Add support for new scope attribute returned by the "Get a diff of the dependencies between commits" (GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}) API

Fixes

  • Tweak documentation for repo starring related APIs (GET /repos/{owner}/{repo}/stargazers, GET /users/{username}/starred and GET /user/starred) to clarify what Accept header to send to get information about when stars were created

  • Tweak documentation for "Get community profile metrics" API (GET /repos/{owner}/{repo}/community/profile) to clarify that it only works with public repos which are not forks

  • Document the size attribute returned on repos across the API

  • Document that APIs can return 422 errors when an endpoint has been spammed with many requests

  • Document 301 status returned by labels-related APIs if the repo has been renamed or moved

  • Document 404 Not Found status returned by labels-related APIs

A whole project to check? Paste its package.json in the dependency check: every deprecated, outdated or vulnerable dependency, with what to upgrade to. Free, no account.