@octokit/openapi-types
29.0.1 · 29 Aug 2026MIT97.2M / weekRepositoryHomepagenpmAtom feed
Upgrading @octokit/openapi-types From 13.2.0 to 13.13.1
13 releases in betweenevery note read
- 1
- change to make
- 0
- advisories fixed
- 23
- new
- 11
- fixes
Before you upgrade
Tick each one off as you go- Deprecated13.9.0
Release by release
13.13.0 – 13.13.12 releases, nothing new or fixed in the notes
- New
Add support for new
display_titleattribute returned on workflow runs across the API (e.g. inGET /repos/{owner}/{repo}/actions/runs)
- New
- New
Add new "List CodeQL databases for a repository" API (
GET /repos/{owner}/{repo}/code-scanning/codeql/databases) - New
Add new "Get a CodeQL database for a repository" API (
GET /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}) - Fixed
Update descriptions for "Create or update file contents" (
PUT /repos/{owner}/{repo}/contents/{path}) and "Delete a file" (DELETE /repos/{owner}/{repo}/contents/{path}) APIs to clarify that calling them in parallel may lead to conflicts - Fixed
Correct casing of
github advanced securitytoGitHub Advanced Securityin descriptions - Fixed
Update docs for the "Update a secret scanning alert" API (
PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}) to clarify that aresolutionmust be provided when settingstatetoresolved - Fixed
Use
enums rather thanstringtypes with a list of accepted values in thedescription(e.g. theconclusionattribute returned in the "Get a job for a workflow run" API [GET /repos/{owner}/{repo}/actions/jobs/{job_id}])
- New
- New
Add support for new
github_com_enterprise_rolesattribute returned by the "List enterprise consumed licenses" API (GET /enterprises/{enterprise}/consumed-licenses), marking the old singulargithub_com_enterprise_roleattribute as deprecated - New
Add support for filtering the "List repository collaborators" API (
GET /repos/{owner}/{repo}/collaborators) bypermissionusing a query param - Fixed
Update type documentation to flag the "List enterprise consumed licenses" API (
GET /enterprises/{enterprise}/consumed-licenses) as beta - Fixed
Clarify in type documentation that the "Get or update file contents" API (
PUT /repos/{owner}/{repo}/contents/{path}) requires theworkflowscope - Fixed
Adding missing type documentation for the "List repository webhooks" API (
GET /repos/{owner}/{repo}/hooks)
- New
- Fixed
Tweak description for "Get a tree" API (
GET /repos/{owner}/{repo}/git/trees/{tree_sha}) to clarify maximum limits on size and number of entries and document allowed response statuses for the "Update a team" API (PATCH /orgs/{org}/teams/{team_slug})
- Fixed
- Deprecated
Mark
use_squash_pr_title_as_defaultattribute on repos as deprecated in favour ofsquash_merge_commit_title - New
Add support for new public beta APIs for creating, reading, updating and deleting custom repo roles (
POST /orgs/{org}/custom_roles,PATCH /orgs/{org}/custom_roles/{role_id},DELETE /orgs/{org}/custom_roles/{role_id},GET /orgs/{org}/fine_grained_permissions) - New
Add support for new
description,base_role,permissions,organization,created_atandupdated_atfields where custom repo roles are returned in the API - Fixed
Update description of APIs for listing package versions (e.g.
GET /orgs/{org}/packages/{package_type}/{package_name}/versions) to clarify that they returned paginated lists ("Get all..." -> "List...") - Fixed
Update description of "List workflow runs" (
GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs) API to the more indicative "List workflow runs for a workflow" - Fixed
Correct description of
sharequest body parameter in the "Delete a file" API (DELETE /repos/{owner}/{repo}/contents/{path})
- Deprecated
- New
Add support for filtering "List workflows runs for a repository" (
GET /repos/{owner}/{repo}/actions/runs) and "List workflow runs [for a workflow]" (GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs) byhead_sha
- New
- New
Add support for
is_alphanumericboolean attribute for autolinks, accepted in the request body of the "Create an autolink reference for a repository" (POST /repos/{owner}/{repo}/autolinks) API and returned on autolinks across the API - New
Add support for
rule.help_uriattribute returned on code scanning alerts across the API (GET /enterprises/{enterprise}/code-scanning/alerts,GET /orgs/{org}/code-scanning/alerts,GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number},PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}) - New
Add support for long-standing
anonymous_access_enabledboolean attribute returned on repos across the API - New
Add
503as a potential response status code across various API operations
- New
8 other lines we could not sort, mostly version bumps
- 13.13.1
Revert "feat: publish new GitHub Enterprise Cloud (GHEC) specific
@octokit/openapi-types-ghecpackage, plus lots of API changes (#251)" - 13.8.0
Tweak the recently-added
state_reasonattribute on issues to be a enum (completed,not_plannedorreopened) rather than an unbounded string - 13.7.0
Tweak documentation for "Create an autolink reference for a repository" (
POST /repos/{owner}/{repo}/autolinks) to read more smoothly - 13.7.0
Clarify in documentation that the "Create a repository using a template" (
POST /repos/{template_owner}/{template_repo}/generate) doesn't require any special permissions with a public repo - 13.7.0
Drop
302as a potential response status code forGET /orgs/{org}/members, which hasn't been returned for nearly 8 years - 13.5.0
Update description of
GET /organizations/{organization_id}/custom_rolesto clarify required permissions - 13.5.0
Update description of
DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}to clarify how sets of analyses work - 13.5.0
Update description for
GET /repos/{owner}/{repo}/contents/{path}to clarify that download links expire
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.