npm · #845 most downloaded on npm

@octokit/openapi-types

29.0.1octokit/openapi-types.ts ↗New releases in your daily digest, changelog included.

Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

Last release 1 months ago
29 Aug 2026
Release timing varies
gaps range from 2 weeks to 9 months
Nearly every release is documented
notes for 60 of the last 60 stable releases
1 version withdrawn
withdrawn after publishing
6 years old
162 releases · first in 2020

Release timeline

162 releases since 2020

2020202120222023202420252026

20202026

One column per quarter.

Releases

6.2.128 Apr 2021
POST /repos/{owner}/{repo}/deployments (repos/create-deployment) does not accept a created_at parameter
6.2.1 (2021-04-28)

Bug Fixes

POST /repos/{owner}/{repo}/deployments (repos/create-deployment) does not accept a created_at parameter (#79) (80bb844)
Open source →
6.2.027 Apr 2021
GET /repos/{owner}/{repo}/pages/health
6.2.0 (2021-04-27)

Features

GET /repos/{owner}/{repo}/pages/health (#78) (f902742)

6.1.123 Apr 2021

description and response data types updates for code-scanning endpoints

6.1.1 (2021-04-23)

Bug Fixes

description and response data types updates for code-scanning endpoints (#75) (90472a9)

Open source →

6.1.021 Apr 2021

DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps - Remove app access restrictions

6.1.0 (2021-04-21)

Features

DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps - Remove app access restrictions (#74) (35da498)

Open source →

6.0.024 Mar 2021

operations["packages/get-all-package-versions-for-a-package-owned-by-an-org"] is now operations["packages/get-all-package-versions-for-package-owned-b

BREAKING CHANGES

operations["packages/get-all-package-versions-for-a-package-owned-by-an-org"] is now operations["packages/get-all-package-versions-for-package-owned-by-org"];
operations["packages/get-all-package-versions-for-a-package-owned-by-the-authenticated-user"] is now operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"];

Features

Operations

GET /repos/{owner}/{repo}/readme/{dir}

parameters

GET /applications/grants: add client_id query parameter
GET /authorizations: add client_id query parameter
GET /licenses: page query parameter
GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories, GET /orgs/{org}/actions/secrets/{secret_name}/repositories, GET /orgs/{org}/audit-log, GET /orgs/{org}/packages/{package_type}/{package_name}/versions, GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head, GET /orgs/{org}/actions/secrets/{secret_name}/repositories, GET /user/packages/{package_type}/{package_name}/versions: page/per_page query parameters
GET /orgs/{org}/migrations, GET /orgs/{org}/migrations/{migration_id}: exclude query parameter
POST /orgs/{org}/packages/{package_type}/{package_name}/restore: token query parameter
GET /orgs/{org}/packages/{package_type}/{package_name}/versions: state query parameter
GET /orgs/{org}/teams/{team_slug}/discussions: pinned query parameter
DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}: confirm_delete is nullable
GET /repos/{owner}/{repo}/deployments: environment query parameter is nullable
GET /repos/{owner}/{repo}/forks: sort query parameter can be set to "watchers"
GET /repos/{owner}/{repo}/pulls/comments: sort query parameter
GET /scim/v2/enterprises/{enterprise}/Groups: filter and excludedAttributes query parameters
GET /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}: excludedAttributes query parameter
GET /scim/v2/enterprises/{enterprise}/Users: filter query parameter
GET /scim/v2/enterprises/{enterprise}/Groups: filter query parameter
POST /user/packages/{package_type}/{package_name}/restore: token query parameter
GET /user/packages/{package_type}/{package_name}/versions: state query parameter

parameter schemas

code-scanning-alert-state can be set to closed
per can be set to an empty string ""

Open source →

5.3.28 Mar 2021

## 5.3.2 (2021-03-08) ### Bug Fixes * description updates

5.3.2 (2021-03-08)

Bug Fixes

description updates (#64) (9e3e73c)

Open source →

5.3.15 Mar 2021

## 5.3.1 (2021-03-05) ### Bug Fixes * descriptions updates

5.3.1 (2021-03-05)

Bug Fixes

descriptions updates (#62) (555184c)

Open source →

5.3.04 Mar 2021

DELETE /applications/{client_id}/token: access_token required in requestBody, PUT /orgs/{org}/actions/secrets/{secret_name}: pattern added to encrypte

5.3.0 (2021-03-04)

Features

DELETE /applications/{client_id}/token: access_token required in requestBody, PUT /orgs/{org}/actions/secrets/{secret_name}: pattern added to encrypted_value, PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}: schema added for Operations items in requestBody, PUT /repos/{owner}/{repo}/environments/{environment_name}: improved schema for requestBody parameters. Fixes POST /repos/{owner}/{repo}/check-runs: request body schema uses oneOf instead of anyOf for different status restrictions (#61) (ca01dc7)

Open source →

5.2.22 Mar 2021

check run and gist types for body parameters

5.2.2 (2021-03-02)

Bug Fixes

check run and gist types for body parameters (#60) (39d802a)

Open source →

5.2.128 Feb 2021

## 5.2.1 (2021-02-28) ### Bug Fixes * description updates

5.2.1 (2021-02-28)

Bug Fixes

description updates (#58) (f93082b)

Open source →

5.2.026 Feb 2021

GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals, {GET,POST} /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments, GET /repos/{own

5.2.0 (2021-02-26)

Features

GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals, {GET,POST} /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments, GET /repos/{owner}/{repo}/environments, {GET,PUT,DELETE} /repos/{owner}/{repo}/environments/{environment_name}, GET /repositories/{repository_id}/environments/{environment_name}/secrets, GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key, {GET,PUT,DELETE} /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name} (#57) (66256e1)

Open source →

5.1.123 Feb 2021

correct documentation URLs in descriptions

5.1.1 (2021-02-23)

Bug Fixes

correct documentation URLs in descriptions (#56) (1d3136c)

Open source →

5.1.018 Feb 2021

{GET,DELETE} /orgs/{org}/packages/{package_type}/{package_name}

Features

(#53) (ee3733b)

{GET,DELETE} /orgs/{org}/packages/{package_type}/{package_name}
POST /orgs/{org}/packages/{package_type}/{package_name}/restore
GET /orgs/{org}/packages/{package_type}/{package_name}/versions
{GET,DELETE} /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}
POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore
{GET,DELETE} /user/packages/{package_type}/{package_name}
POST /user/packages/{package_type}/{package_name}/restore
GET /user/packages/{package_type}/{package_name}/versions
{GET,DELETE} /user/packages/{package_type}/{package_name}/versions/{package_version_id}
POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore
GET /users/{username}/packages/{package_type}/{package_name}
GET /users/{username}/packages/{package_type}/{package_name}/versions
GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}

Open source →

5.0.017 Feb 2021Deprecated

The instances response field is deprecated and will, in future, not be included in the response of code scanning alerts endpoints. The same informatio…

via (#52) (5062c08)

BREAKING CHANGES

code-scanning-alert-instances schema removed.

The instances response field is deprecated and will, in future, not be included in the response of code scanning alerts endpoints. The same information can now be retrieved via a GET request to the URL specified by instances_url.
schema code-scanning-alert-ref renamed to code-scanning-ref
schema code-scanning-alert-rule renamed to code-scanning-alert-rule-summary
schema code-scanning-alert-code-scanning-alert-items renamed to code-scanning-alert-items
schema code-scanning-alert-code-scanning-alert renamed to code-scanning-alert-rule
schema code-scanning-analysis-ref renamed to code-scanning-ref
schema code-scanning-analysis-code-scanning-analysis renamed to code-scanning-analysis

Features

GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances
GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}
GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}.

Bug Fixes

correct response types for GET /user/emails. Adds missing response data type for POST /markdown (#44) (4c5d99a)

BREAKING CHANGES

interactions/get-restrictions-for-your-public-repos operation is now interactions/get-restrictions-for-authenticated-user
interactions/set-restrictions-for-your-public-repos operation is now interactions/set-restrictions-for-authenticated-user
interactions/remove-restrictions-for-your-public-repos operation is now interactions/remove-restrictions-for-authenticated-user

Open source →

3.5.02 Feb 2021

auto_merge response data key and component

3.5.0 (2021-02-02)

Features

auto_merge response data key and component (#43) (d32ba85)

Open source →

3.4.131 Jan 2021

context parameter description update

3.4.1 (2021-01-31)

Bug Fixes

context parameter description update (#39) (36d2a0b)

Open source →

3.4.031 Jan 2021

order parameter for GET /enterprises/{enterprise}/audit-log and GET /orgs/{org}/audit-log operations

3.4.0 (2021-01-31)

Features

order parameter for GET /enterprises/{enterprise}/audit-log and GET /orgs/{org}/audit-log operations (#38) (52bf6e3)

Open source →

3.3.026 Jan 2021

add descriptions to members_can_create_pages, members_can_create_public_pages, members_can_create_private_pages (orgs/update)

3.3.0 (2021-01-26)

Features

add descriptions to members_can_create_pages, members_can_create_public_pages, members_can_create_private_pages (orgs/update) (#36) (f805026)

Open source →

3.2.125 Jan 2021

authorized_credential_title and authorized_credential_note can be null

3.2.1 (2021-01-25)

Bug Fixes

authorized_credential_title and authorized_credential_note can be null (#35) (c8a4653)

Open source →

3.2.022 Jan 2021

POST /repos/{owner}/{repo}/branches/{branch}/rename

3.2.0 (2021-01-22)

Features

POST /repos/{owner}/{repo}/branches/{branch}/rename (#31) (5c30618)

Open source →

3.1.121 Jan 2021

## 3.1.1 (2021-01-21) ### Bug Fixes * improved response types

3.1.1 (2021-01-21)

Bug Fixes

improved response types (#28) (4649d1a)

Open source →

3.1.021 Jan 2021

# 3.1.0 (2021-01-21) ### Features * author_association schema

3.1.0 (2021-01-21)

Features

author_association schema (#26) (7023f50)

Open source →

3.0.021 Jan 2021

gist-full schema has been removed

BREAKING CHANGES

gist-full schema has been removed (#25) (2eae5c7)

Features

GET /orgs/{org}/failed_invitations (orgs/list-failed-invitations), DELETE /orgs/{org}/invitations/{invitation_id} (orgs/cancel-invitation) (#25) (2eae5c7)

Fixes

Several schema improvements, description fixes (#25) (2eae5c7)

Open source →

2.3.118 Jan 2021

improved response types for apps/create-installation-access-token operation

2.3.1 (2021-01-18)

Bug Fixes

improved response types for apps/create-installation-access-token operation (#24) (4c7b3df)

Open source →

2.3.015 Jan 2021

POST /applications/{client_id}/token/scoped

All changes from (#23)

Features

POST /applications/{client_id}/token/scoped
app-permissions component schema.

Fixes

Sets required keys for many objects
Removes graduated giant-sentry-fist preview
Corrects documentation URLs in descriptions

Open source →

2.2.05 Jan 2021

union types for check run conclusion and status

2.2.0 (2021-01-05)

Features

union types for check run conclusion and status (#20) (4e0abb4)

Open source →

2.1.05 Jan 2021

GET /enterprises/{enterprise}/audit-log, GET /orgs/{org}/audit-log, components/schemas/label Interface

2.1.0 (2021-01-05)

Features

GET /enterprises/{enterprise}/audit-log, GET /orgs/{org}/audit-log, components/schemas/label Interface (#19) (78c4d13)

Open source →

2.0.120 Dec 2020

add "types" key to package.json (#18) (7cd816b), closes #discussioncomment-227786

2.0.1 (2020-12-20)

Bug Fixes

add "types" key to package.json (#18) (7cd816b), closes #discussioncomment-227786

Open source →

2.0.03 Dec 2020

components/schemas/code-scanning-alert-number renamed to components/schemas/alert-number

BREAKING CHANGES

components/schemas/code-scanning-alert-number renamed to components/schemas/alert-number
components/schemas/code-scanning-alert-created-at renamed to components/schemas/alert-created-at
components/schemas/code-scanning-alert-url renamed to components/schemas/alert-url
components/schemas/code-scanning-alert-html-url renamed to components/schemas/alert-html-url

Features

GET /repos/{owner}/{repo}/secret-scanning/alerts, GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number} (#15) (af9bbf8)

Open source →

1.2.21 Dec 2020

update to @octokit/openapi v1.0.3

1.2.2 (2020-12-01)

Bug Fixes

update to @octokit/openapi v1.0.3 (#13) (cd7e79d)

Open source →

1.2.11 Dec 2020

update to @octokit/openapi v1.0.2

1.2.1 (2020-12-01)

Bug Fixes

update to @octokit/openapi v1.0.2 (#12) (e7d02db)

Open source →

1.2.030 Nov 2020

Add "octokit": { "openapi-version": "1.0.1" } to package.json

Features

Add "octokit": { "openapi-version": "1.0.1" } to package.json (#11)

Open source →

1.1.025 Nov 2020

namespace keys for branch protenction request bodies

1.1.0 (2020-11-25)

Features

namespace keys for branch protenction request bodies (#9) (1bbac3a)

Open source →

1.0.310 Nov 2020

description and documentation URL updates

1.0.3 (2020-11-10)

Bug Fixes

description and documentation URL updates (36baf50)

Open source →

1.0.29 Nov 2020

## 1.0.2 (2020-11-09) ### Bug Fixes * optional referenced parameters

1.0.2 (2020-11-09)

Bug Fixes

optional referenced parameters (a3bbe1a)

Open source →

1.0.19 Nov 2020

use intersection type in case of additionalProperties

1.0.1 (2020-11-09)

Bug Fixes

use intersection type in case of additionalProperties (0522b4b)

Open source →

1.0.029 Oct 2020

# 1.0.0 (2020-10-29) ### Features * initial version

1.0.0 (2020-10-29)

Features

initial version (#1) (5693954)

Open source →

Your coding agent can read these notes before it upgrades. Set up the MCP server →

@octokit/openapi-types

Release timeline

Releases

6.2.1 (2021-04-28)

Bug Fixes

6.2.0 (2021-04-27)

Features

6.1.1 (2021-04-23)

Bug Fixes

6.1.0 (2021-04-21)

Features

BREAKING CHANGES

Features

5.3.2 (2021-03-08)

Bug Fixes

5.3.1 (2021-03-05)

Bug Fixes

5.3.0 (2021-03-04)

Features

5.2.2 (2021-03-02)

Bug Fixes

5.2.1 (2021-02-28)

Bug Fixes

5.2.0 (2021-02-26)

Features

5.1.1 (2021-02-23)

Bug Fixes

Features

BREAKING CHANGES

Features

Fixes

4.0.4 (2021-02-14)

Bug Fixes

4.0.3 (2021-02-12)

Bug Fixes

4.0.2 (2021-02-10)

Bug Fixes

4.0.1 (2021-02-03)

Bug Fixes

4.0.0 (2021-02-02)

Bug Fixes

BREAKING CHANGES

3.5.0 (2021-02-02)

Features

3.4.1 (2021-01-31)

Bug Fixes

3.4.0 (2021-01-31)

Features

3.3.0 (2021-01-26)

Features

3.2.1 (2021-01-25)

Bug Fixes

3.2.0 (2021-01-22)

Features

3.1.1 (2021-01-21)

Bug Fixes

3.1.0 (2021-01-21)

Features

BREAKING CHANGES

Features

Fixes

2.3.1 (2021-01-18)

Bug Fixes

Features

Fixes

2.2.0 (2021-01-05)

Features

2.1.0 (2021-01-05)

Features

2.0.1 (2020-12-20)

Bug Fixes

BREAKING CHANGES

Features

1.2.2 (2020-12-01)

Bug Fixes

1.2.1 (2020-12-01)

Bug Fixes

Features

1.1.0 (2020-11-25)

Features