@octokit/openapi-types
29.0.1 · 29 Aug 2026MIT97.2M / weekRepositoryHomepagenpmAtom feed
162 stable releases, newest first, by release line. Notes are quoted as the maintainers published them.
- 13.x
13.1.0
16 Aug 2022Add new Enterprise licenses APIs (
GET /enterprises/{enterprise}/consumed-licenses,GET /enterprises/{enterprise}/license-sync-status)
13.0.1
15 Aug 2022build: allow download script to handle more than 30 GitHub release assets
13.0.0
15 Aug 2022- Breaking
This removes support for the now-defunkt OAuth Authorizations APIs. These were disabled on GitHub.com at the end of 2020, but the OpenAPI specs were not updated so this code was not cleaned up.
Document the required scopes to use
GET /orgs/{org}/code-scanning/alertswith public reposAdd new Security Managers APIs (
GET /orgs/{org}/security-managers,PUT /orgs/{org}/security-managers/teams/{team_slug}andDELETE /orgs/{org}/security-managers/teams/{team_slug})
Breaking changes
- Breaking
This removes support for the now-defunkt OAuth Authorizations APIs. These were disabled on GitHub.com at the end of 2020, but the OpenAPI specs were not updated so this code was not cleaned up.
Other changes
Document the required scopes to use
GET /orgs/{org}/code-scanning/alertswith public reposAdd new Security Managers APIs (
GET /orgs/{org}/security-managers,PUT /orgs/{org}/security-managers/teams/{team_slug}andDELETE /orgs/{org}/security-managers/teams/{team_slug})Add new deployment branch policy APIs (
GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies,POST /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies,GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id},PUT /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id},DELETE /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id})Add new GitHub Pages API (
POST /repos/{owner}/{repo}/pages/deployment)Correct types for
GET /enterprise-installation/{enterprise_or_org}/server-statisticsto reflect that it returns an array of resultsAdd new
retention_period_minutesandretention_expires_atfields returned on CodespacesCorrect types for Commit Statuses in the API (e.g. returned by
POST /repos/{owner}/{repo}/statuses/{sha}) to reflect thattarget_urlanddescriptioncan benullCorrect describe the
typeof items returned by theGET /repos/{owner}/{repo}/contents/{path}API as enum (dir,file,submodule,symlink)Add new
added_byandlast_usedattributes on Deploy Keys returned across the APICorrect type of
permissionrequest body parameter forPUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}andPUT /repos/{owner}/{repo}/collaborators/{username}to reflect that custom role names can be specified, not just values in a GitHub-set enumRemove
pageandper_pageparameters forGET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewerswhich are not actually supportedAdd support for
build_typeparameter inPOST /repos/{owner}/{repo}/pagesandPUT /repos/{owner}/{repo}/pagesMark that
commit_id,pathandlineare in fact required for `POST /repos/{owner}/{repo}/pulls/{pull_number}/commentsCorrect types for
POST /repos/{owner}/{repo}/pulls/{pull_number}/reviewsto reflect thateventmust be sent toDISMISS
- 12.x
12.11.0
27 Jul 2022New
GET /enterprises/{enterprise}/code-scanning/alertsendpoint and description updates for multiple other endpoints
12.10.1
18 Jul 2022Add example for
use_squash_pr_title_as_defaultproperty when repositories are returned in the API
12.10.0
15 Jul 2022Add new
GET /repos/{owner}/{repo}/codespaces/newAPI operationUpdate operation parameter descriptions, operation descriptions and response examples
12.9.1
14 Jul 2022Improve parameter descriptions for
GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
12.9.0
13 Jul 2022Improve operation descriptions when an API operation is not available in a particular context (e.g. GHAE or a GHES version)
Improve parameter descriptions for
POST /authorizations,PUT /authorizations/clients/{client_id}andPUT /authorizations/clients/{client_id}/{fingerprint}Add type annotations with
examples and annotations about strings'formats, where available
Improve operation descriptions when an API operation is not available in a particular context (e.g. GHAE or a GHES version)
Improve parameter descriptions for
POST /authorizations,PUT /authorizations/clients/{client_id}andPUT /authorizations/clients/{client_id}/{fingerprint}Add type annotations with
examples and annotations about strings'formats, where available
12.8.0
5 Jul 2022Add support for returning
dependency_snapshots-specific rate limits inGET /rate_limitClarify description to make it clear that
POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deploymentsis only available to required reviewers
12.7.0
4 Jul 2022Add support for specifying a
namefor the forked repository when creating a fork withPOST /repos/{owner}/{repo}/forksWhen a SARIF response is explicitly requested from
GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}, handle it as JSONMark
sortbynumberforGET /repos/{owner}/{repo}/code-scanning/alertsas deprecated
12.6.1
2 Jul 2022Don't mark endpoints as unavailable in GHES 3.5 and GHAE which are in fact available
12.6.0
1 Jul 2022- Removed
Remove defunkt
GET /repos/{owner}/{repo}/community/code_of_conductAPI Mark
assigneesand request body as required in theDELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees(i.e. remove assignees from an issue) APIAllow
selected_repository_idsforPUT /orgs/{org}/actions/secrets/{secret_name}ANDPUT /orgs/{org}/dependabot/secrets/{secret_name}to be integers or strings
Mark
assigneesand request body as required in theDELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees(i.e. remove assignees from an issue) API- Removed
Remove defunkt
GET /repos/{owner}/{repo}/community/code_of_conductAPI Allow
selected_repository_idsforPUT /orgs/{org}/actions/secrets/{secret_name}ANDPUT /orgs/{org}/dependabot/secrets/{secret_name}to be integers or stringsRemove unused
prebuild_availabilityenum values (blob,pool) for Codespaces machinesAdd for
is_alphanumericboolean response attribute toGET /repos/{owner}/{repo}/autolinks,POST /repos/{owner}/{repo}/autolinksandGET /repos/{owner}/{repo}/autolinks/{autolink_id}
12.5.0
28 Jun 2022- Removed
Remove no longer supported
GET /repos/{owner}/{repo}/community/code_of_conductAPI PUT /enterprises/{enterprise}/actions/oidc/customization/issuerGET /orgs/{org_id}/codespaces
PUT /enterprises/{enterprise}/actions/oidc/customization/issuerGET /orgs/{org_id}/codespacesPOST /orgs/{org}/members/{username}/codespaces/{codespace_name}/stopGET /orgs/{org}/actions/oidc/customization/subPUT /orgs/{org}/actions/oidc/customization/subDELETE /orgs/{org}/members/{username}/codespaces/{codespace_name}Add additional examples and error response codes
GET /repos/{owner}/{repo}/actions/cachesDELETE /repos/{owner}/{repo}/actions/cachesDELETE /repos/{owner}/{repo}/actions/caches/{cache_id}GET /repos/{owner}/{repo}/actions/oidc/customization/subPUT /repos/{owner}/{repo}/actions/oidc/customization/subSupport for optional
retention_period_minutesrequest body parameter inPOST /repos/{owner}/{repo}/codespaces,POST /repos/{owner}/{repo}/pulls/{pull_number}/codespacesandPOST /user/codespacesMark
POST /repos/{owner}/{repo}/dependency-graph/snapshotsas available on GitHub.com, not just GitHub Enterprise CloudMark
assigneesrequest body parameter - and the request body more generally - as required inDELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees- Removed
Remove no longer supported
GET /repos/{owner}/{repo}/community/code_of_conductAPI
12.4.0
20 Jun 2022Add new
beforeandafterparameters toGET /orgs/{org}/secret-scanning/alertsandGET /repos/{owner}/{repo}/secret-scanning/alerts
12.3.0
20 Jun 2022GHES: v3.3, v3.4, v3.5
12.2.0
20 Jun 2022POST /repos/{owner}/{repo}/dependency-graph/snapshots, fix: description and example updates
12.1.0
15 Jun 2022GET /enterprises/{enterprise}/actions/runner-groups-visible-to-organizationparamterGET /enterprises/{enterprise}/settings/billing/advanced-securityGET /orgs/{org}/actions/runner-groups- new parameter:visible_to_repository
Features
GET /enterprises/{enterprise}/actions/runner-groups-visible-to-organizationparamterGET /enterprises/{enterprise}/settings/billing/advanced-securityGET /orgs/{org}/actions/runner-groups- new parameter:visible_to_repositoryGET /orgs/{org}/credential-authorizations- new parameters:per_page,page,loginGET /orgs/{org}/secret-scanning/alerts- new parameters:sort,directionGET /orgs/{org}/settings/billing/advanced-securityPATCH /orgs/{org}/actions/runner-groups/{runner_group_id}- new parameters:allows_public_repositories,restricted_to_workflows,selected_workflowsPATCH /orgs/{org}- new parameter:members_can_fork_private_repositoriesPOST /orgs/{org}/actions/runner-groups- new parameters:allows_public_repositories,restricted_to_workflows,selected_workflowsPOST /orgs/{org}/migrations- new parrameters:exclude_metadata,exclude_git_data,org_metadata_onlyPOST /orgs/{org}/repos- new parameter:use_squash_pr_title_as_defaultPOST /user/migrations- new parrameters:exclude_metadata,exclude_git_data,org_metadata_onlyPUT /orgs/{org}/outside_collaborators/{username}- new parameter:asyncGET /repos/{owner}/{repo}/actions/runs: new parameter:check_suite_idGET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs: new parameter:check_suite_idGET /repos/{owner}/{repo}/code-scanning/alerts: new parameters:direction,sortGET /repos/{owner}/{repo}/environments: new parameters:per_page,pageGET /repos/{owner}/{repo}/secret-scanning/alerts: new parameters:direction,sortPATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews: new parameters:dismissal_restrictions.apps,bypass_pull_request_allowancesPATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks: new parameter:checksPATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}: new parameter:dismissed_commentPATCH /repos/{owner}/{repo}:secret_scanning_push_protection,use_squash_pr_title_as_defaultPOST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun: new parameter:enable_debug_loggingPOST /user/gpg_keys: new parameter:namePUT /repos/{owner}/{repo}/branches/{branch}/protection: new parameter:required_status_checks.checks,required_pull_request_reviews.{apps,bypass_pull_request_allowances},block_creationsUpdated
components.parameterscomponents:
repository.{allow_update_branch,use_squash_pr_title_as_default,use_squash_pr_title_as_default}components:
server-statisticscomponents:
actions-default-workflow-permissionscomponents:
actions-can-approve-pull-request-reviewscomponents:
actions-get-default-workflow-permissionscomponents:
actions-set-default-workflow-permissionscomponents:
runner-groups-enterprise.{workflow_restrictions_read_only,restricted_to_workflows,selected_workflows}components:
runner-labelcomponents:
nullable-alert-updated-atcomponents:
minimal-repositorycomponents:
actions-billing-usage.minutes_used_breakdown.{linux_4_core,linux_8_core,linux_16_core,linux_32_core,linux_64_core,windows_4_core,windows_8_core,windows_16_core,windows_32_core,windows_64_core,total}components:
advanced-security-active-committers-usercomponents:
advanced-security-active-committers-repositorycomponents:
advanced-security-active-committerscomponents:
issue.state_reasoncomponents:
issue.draftcomponents:
api-overview.ssh-keyscomponents:
organization-custom-repository-rolecomponents:
actions-cache-usage-by-repositorycomponents:
runner-groups-org.{workflow_restrictions_read_only,restricted_to_workflows,selected_workflows}components:
code-scanning-alert-statecomponents:
alert-updated-atcomponents:
code-scanning-alert-fixed-atcomponents:
code-scanning-alert-dismissed-commentcomponents:
code-scanning-alert-rulecomponents:
code-scanning-organization-alert-itemscomponents:
credential-authorization.authorized_credential_expires_atcomponents:
organization-dependabot-secretcomponents:
dependabot-public-keycomponents:
external-groupcomponents:
external-groupscomponents:
migration.org_metadata_onlycomponents:
nullable-minimal-repository.role_namecomponents:
team-repository.role_namecomponents:
rate-limit-overview.scimcomponents:
security-and-analysiscomponents:
full-repository.use_squash_pr_title_as_defaultcomponents:
artifact.workflow_runcomponents:
actions-workflow-access-to-repositorycomponents:
referenced_workflowcomponents:
workflowrun.{path,referenced_workflows,actor,triggering_actor}components:
protected-branch-required-status-checkcomponents:
protected-branch-pull-request-review.{dismissal_restrictions.apps,bypass_pull_request_allowances}components:
branch-protection.block_creationscomponents:
status-check-policy.checkscomponents:
protected-branch.{dismissal_restrictions.apps,bypass_pull_request_allowances,block_creations}components:
check-suite.{rerequestable,runs_rerequestable}components:
code-scanning-alert-rule-summary.tagscomponents:
code-scanning-alert-items.{updated_at,fixed_at,dismissed_comment}components:
code-scanning-sarifs-status.errorscomponents:
nullable-codespace-machinecomponents:
codespacecomponents:
codespace-machinecomponents:
repo-codespaces-secretcomponents:
codespaces-public-keycomponents:
collaborator.role_namecomponents:
nullable-collaboratorcomponents:
dependabot-secretcomponents:
nullable-issuecomponents:
state-change-issue-eventcomponents:
timeline-issue-eventscan be of typestate-change-issue-eventcomponents:
page.build_typecomponents:
secret-scanning-alert.{updated_at,secret_type_display_name}components:
secret-scanning-location-commitcomponents:
tag-protectioncomponents:
issue-search-result-item.state_reasoncomponents:
codespaces-secretcomponents:
gpg-key.{name,revoked}
Bug Fixes
POST /app-manifests/{code}/conversionshas no request bodyGET /projects/{project_id}/collaborators/{username}/permission: correct response type and examplePATCH /repos/{owner}/{repo}:visibilityparameter cannot be set tovisibilityPOST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun: no longer deprecatedRemove defunkt
DELETE /reactions/{reaction_id}Remove defunkt
POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments
12.0.0
12 Jun 2022- Breaking
Remove GHES 3.0 and 3.1 schemas and types
Remove GHES 3.0 and 3.1
- 11.x
11.2.0
11 Oct 2021GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs
11.1.0
8 Oct 2021exclude-pull-requestscomponent.exclude_pull_requestsparameter added to action runs operations
11.0.0
7 Oct 2021- Breaking
Operation ID
users/list-blocked-by-authenticatedis nowusers/list-blocked-by-authenticated-user - Breaking
Operation ID
users/set-primary-email-visibility-for-authenticatedis nowusers/set-primary-email-visibility-for-authenticated-user - Breaking
Operation ID
users/list-emails-for-authenticatedis nowusers/list-emails-for-authenticated-user
Features
GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_num},GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_num}/logs,POST /repos/{owner}/{repo}/releases/generate-notes,POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest. Graduatenebula,zzzax,switcheroo,baptistepreviews. Removes defunkt/repos/{owner}/{repo}/actions/runs/{run_id}/retryendpoint. Renames operation IDs to normalize-authenticated-usersuffix
Breaking changes
- Breaking
Operation ID
users/list-blocked-by-authenticatedis nowusers/list-blocked-by-authenticated-user - Breaking
Operation ID
users/set-primary-email-visibility-for-authenticatedis nowusers/set-primary-email-visibility-for-authenticated-user - Breaking
Operation ID
users/list-emails-for-authenticatedis nowusers/list-emails-for-authenticated-user - Breaking
Operation ID
users/add-email-for-authenticatedis nowusers/add-email-for-authenticated-user - Breaking
Operation ID
users/delete-email-for-authenticatedis nowusers/delete-email-for-authenticated-user - Breaking
Operation ID
users/list-followed-by-authenticatedis nowusers/list-followed-by-authenticated-user - Breaking
Operation ID
users/list-gpg-keys-for-authenticatedis nowusers/list-gpg-keys-for-authenticated-user - Breaking
Operation ID
users/create-gpg-key-for-authenticatedis nowusers/create-gpg-key-for-authenticated-user - Breaking
Operation ID
users/get-gpg-key-for-authenticatedis nowusers/get-gpg-key-for-authenticated-user - Breaking
Operation ID
users/delete-gpg-key-for-authenticatedis nowusers/delete-gpg-key-for-authenticated-user - Breaking
Operation ID
apps/add-repo-to-installationis nowapps/add-repo-to-installation-for-authenticated-user - Breaking
Operation ID
apps/remove-repo-from-installationis nowapps/remove-repo-from-installation-for-authenticated-user - Breaking
Operation ID
users/list-public-ssh-keys-for-authenticatedis nowusers/list-public-ssh-keys-for-authenticated-user - Breaking
Operation ID
users/create-public-ssh-key-for-authenticatedis nowusers/create-public-ssh-key-for-authenticated-user - Breaking
Operation ID
users/get-public-ssh-key-for-authenticatedis nowusers/get-public-ssh-key-for-authenticated-user - Breaking
Operation ID
users/delete-public-ssh-key-for-authenticatedis nowusers/delete-public-ssh-key-for-authenticated-user - Breaking
Operation ID
migrations/list-repos-for-useris nowmigrations/list-repos-for-authenticated-user - Breaking
Operation ID
users/list-public-emails-for-authenticatedis nowusers/list-public-emails-for-authenticated-user - Breaking
Operation ID
repos/accept-invitationis nowrepos/accept-invitation-for-authenticated-user - Breaking
Operation ID
repos/decline-invitationis nowrepos/decline-invitation-for-authenticated-user
- 10.x
10.6.4
30 Sep 2021Graduate
surturpreview
10.6.3
30 Sep 2021POST /repos/{owner}/{repo}/community/code_of_conductisGET /repos/{owner}/{repo}/community/code_of_conduct
10.6.2
30 Sep 2021Previews graduated:
ant-man,flash,scarlet-witch,squirrel-girl
10.6.1
27 Sep 2021luke-cagepreview graduated
10.6.0
24 Sep 2021Graduate
inertiapreview
10.5.0
23 Sep 2021.protected_domain_state/.pending_domain_unverified_atkeys forpagecomponent (GitHub Pages). Graduation of previews:london,lydian,wyandotte
10.4.0
22 Sep 2021- Deprecated
POST /repos/{owner}/{repo}/actions/runs/{run_id}/retry, DeprecatesPOST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun.run_attempt/previous_attempt_urlproperties forworkflow-runcomponent
10.3.0
22 Sep 2021- Deprecated
POST /repos/{owner}/{repo}/actions/runs/{run_id}/retry, DeprecatesPOST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun.run_attempt/previous_attempt_urlproperties forworkflow-runcomponent
10.2.2
14 Sep 2021Add enum to
statusproperty indiff-entrycomponent
10.2.1
14 Sep 2021Bring back missing
.d.tsfiles
10.2.0
14 Sep 2021allow_forkingproperty for repository components
10.1.5
13 Sep 2021Compenents fixes
10.1.4
12 Sep 2021Debugging semantic-release error
10.1.3
12 Sep 202110.1.2
12 Sep 2021Differentiate between nullable/non-nullable repsponse properties
Features
added components
Bug Fixes
Differentiate between nullable/non-nullable repsponse properties
10.1.1
5 Sep 2021Add
LICENSEfile to published packages
10.1.0
3 Sep 2021POST /repos/{owner}/{repo}/merge-upstream
10.0.0
31 Aug 2021- Breaking
Removes deprecated operations
DELETE /applications/{client_id}/grants/{access_token},{GET,POST,DELETE} /applications/{client_id}/tokens/{access_token} GET /orgs/{org}/packagesGET /user/packages
Breaking changes
- Breaking
Removes deprecated operations
DELETE /applications/{client_id}/grants/{access_token},{GET,POST,DELETE} /applications/{client_id}/tokens/{access_token}
These endpoints have now been sunset. See github.blog/changelog/2021-08-10-sunset-notice-…
Features
GET /orgs/{org}/packagesGET /user/packagesGET /user/{username}/packagesDELETE /users/{username}/packages/{package_type}/{package_name}DELETE /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}POST /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore
Bug fixes
{POST,PUT} /repos/{owner}/{repo}/issues/{issue_number}/labels:labelsrequest body parameter now correctly usesoneOfinstead ofanyOffor conflicting schemas
- 9.x
9.7.0
11 Aug 2021GHAE: autolinks endpoints
9.6.0
10 Aug 2021GHAE types
9.5.0
10 Aug 2021permissionskey in responses now consistently includesmaintainandtriagerole
9.4.0
3 Aug 2021allow_auto_mergeparameter when creating / updating a repository. Search:ownerin repository items may no longer benull
9.3.0
2 Aug 2021{GET,POST} /repos/{owner}/{repo}/autolinks,{GET,DELETE} /repos/{owner}/{repo}/autolinks/{autolink_id}
9.2.0
29 Jul 2021mentions_countkey in release response, mentionreposalias forallwhen filtering issues
9.1.1
23 Jul 2021POST /repos/{owner}/{repo}/releases/{release_id}/assets:namequery parameter is required.head.repois nullable inpull-requestschema
9.1.0
21 Jul 2021createdparameter toactions/list-workflow-runs-for-repoandactions/list-workflow-runsoperations
9.0.0
20 Jul 2021- Breaking
All component keys that had an underscore (
_) in its name have been renamed and now are using a dash (-) instead
Breaking changes
- Breaking
All component keys that had an underscore (
_) in its name have been renamed and now are using a dash (-) instead
- 8.x
8.3.0
13 Jul 2021scarlet-witchpreview graduated. Replaceanytypes withunknown
8.2.1
4 Jul 2021- Removed
Removes
security_severity_levelproperty fromcomponents["schemas"]["code-scanning-alert-rule"]
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.