@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.
- 8.x
8.2.0
3 Jul 2021GET /app/hook/deliveries,GET /app/hook/deliveries/{delivery_id},POST /app/hook/deliveries/{delivery_id}/attempts,
Features
GET /app/hook/deliveries,GET /app/hook/deliveries/{delivery_id},POST /app/hook/deliveries/{delivery_id}/attempts,GET /orgs/{org}/hooks/{hook_id}/deliveries,GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id},POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts,GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries,GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id},POST /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts
8.1.4
30 Jun 2021.security_severity_levelproperty incomponents["schemas"]["code-scanning-alert-rule"]
8.1.3
30 Jun 2021Publish
types.d.ts, nottypes.ts
8.1.2
30 Jun 2021Publish
types.d.ts, nottypes.ts
8.1.1
30 Jun 2021Add README to new packages and correct repository URL
8.1.0
30 Jun 20218.0.0
29 Jun 2021- Breaking
@octokit/openapi-typesno longer exports any code, only types
- 7.x
7.4.0
29 Jun 2021.security_and_analysis.secret_scanningproperty infull-repositoryschema via@octokit/typesv2.23.0
7.3.5
25 Jun 2021PATCH /repos/{owner}/{repo}-security_and_analysis.secret_scanningoption
7.3.4
24 Jun 2021GET /search/labels&GET /search/topicspagination query parameters
7.3.3
23 Jun 2021Lots and lots of type improvements
7.3.2
11 Jun 2021Response types for
pulls/request-reviewers,gists/update,repos/update-information-about-pages-site
7.3.1
11 Jun 2021Response type for
GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
7.3.0
7 Jun 2021has_advanced_securitykey forfull-repositoryresponse schema
7.2.3
28 May 2021Do not make parameters required that have a default property in the OpenAPI spec
7.2.1
21 May 2021Remove empty path objects
7.2.0
21 May 2021POST /repos/{owner}/{repo}/releases/{release_id}/reactions,POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments,GET /repos/{owner}/{repo}/compare/{basehead}. DeprecatesGET /repos/{owner}/{repo}/compare/{base}...{head}andGET /repos/{owner}/{repo}/content_references/{content_reference_id}/attachmentsviaoctokit/openapiv2.21.0
7.1.0
21 May 2021POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve
7.0.0
30 Apr 2021- Breaking
audit-log/get-audit-logis nowenterprise-admin/get-audit-log
- 6.x
6.2.1
28 Apr 2021POST /repos/{owner}/{repo}/deployments(repos/create-deployment) does not accept acreated_atparameter
6.2.0
27 Apr 2021GET /repos/{owner}/{repo}/pages/health
6.1.1
23 Apr 2021Description and response data types updates for code-scanning endpoints
6.1.0
21 Apr 2021DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps- Remove app access restrictions
6.0.0
24 Mar 2021- Breaking
operations["packages/get-all-package-versions-for-a-package-owned-by-an-org"]is nowoperations["packages/get-all-package-versions-for-package-owned-by-org"]; - Breaking
operations["packages/get-all-package-versions-for-a-package-owned-by-the-authenticated-user"]is nowoperations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; GET /repos/{owner}/{repo}/readme/{dir}
Breaking changes
- Breaking
operations["packages/get-all-package-versions-for-a-package-owned-by-an-org"]is nowoperations["packages/get-all-package-versions-for-package-owned-by-org"]; - Breaking
operations["packages/get-all-package-versions-for-a-package-owned-by-the-authenticated-user"]is nowoperations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"];
Features
Operations
GET /repos/{owner}/{repo}/readme/{dir}
parameters
GET /applications/grants: addclient_idquery parameterGET /authorizations: addclient_idquery parameterGET /licenses:pagequery parameterGET /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_pagequery parametersGET /orgs/{org}/migrations,GET /orgs/{org}/migrations/{migration_id}:excludequery parameterPOST /orgs/{org}/packages/{package_type}/{package_name}/restore:tokenquery parameterGET /orgs/{org}/packages/{package_type}/{package_name}/versions:statequery parameterGET /orgs/{org}/teams/{team_slug}/discussions:pinnedquery parameterDELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}:confirm_deleteisnullableGET /repos/{owner}/{repo}/deployments:environmentquery parameter is nullableGET /repos/{owner}/{repo}/forks:sortquery parameter can be set to"watchers"GET /repos/{owner}/{repo}/pulls/comments:sortquery parameterGET /scim/v2/enterprises/{enterprise}/Groups:filterandexcludedAttributesquery parametersGET /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}:excludedAttributesquery parameterGET /scim/v2/enterprises/{enterprise}/Users:filterquery parameterGET /scim/v2/enterprises/{enterprise}/Groups:filterquery parameterPOST /user/packages/{package_type}/{package_name}/restore:tokenquery parameterGET /user/packages/{package_type}/{package_name}/versions:statequery parameter
parameter schemas
code-scanning-alert-statecan be set toclosedpercan be set to an empty string""
- 5.x
5.3.2
8 Mar 2021Description updates
5.3.1
5 Mar 2021Descriptions updates
5.3.0
4 Mar 2021DELETE /applications/{client_id}/token:access_tokenrequired in requestBody,PUT /orgs/{org}/actions/secrets/{secret_name}:patternadded toencrypted_value,PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}: schema added forOperationsitems in requestBody,PUT /repos/{owner}/{repo}/environments/{environment_name}: improved schema for requestBody parameters. FixesPOST /repos/{owner}/{repo}/check-runs: request body schema usesoneOfinstead ofanyOffor differentstatusrestrictions
5.2.2
2 Mar 2021Check run and gist types for body parameters
5.2.1
28 Feb 2021Description updates
5.2.0
26 Feb 2021GET /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}
5.1.1
23 Feb 2021Correct documentation URLs in descriptions
5.1.0
18 Feb 2021{GET,DELETE} /orgs/{org}/packages/{package_type}/{package_name}POST /orgs/{org}/packages/{package_type}/{package_name}/restoreGET /orgs/{org}/packages/{package_type}/{package_name}/versions
Features
{GET,DELETE} /orgs/{org}/packages/{package_type}/{package_name}POST /orgs/{org}/packages/{package_type}/{package_name}/restoreGET /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}/restoreGET /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}/restoreGET /users/{username}/packages/{package_type}/{package_name}GET /users/{username}/packages/{package_type}/{package_name}/versionsGET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}
5.0.0
17 Feb 2021- Breaking
code-scanning-alert-instancesschema 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. - Breaking
Schema
code-scanning-alert-refrenamed tocode-scanning-ref - Breaking
Schema
code-scanning-alert-rulerenamed tocode-scanning-alert-rule-summary
via
Breaking changes
- Breaking
code-scanning-alert-instancesschema 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. - Breaking
Schema
code-scanning-alert-refrenamed tocode-scanning-ref - Breaking
Schema
code-scanning-alert-rulerenamed tocode-scanning-alert-rule-summary - Breaking
Schema
code-scanning-alert-code-scanning-alert-itemsrenamed tocode-scanning-alert-items - Breaking
Schema
code-scanning-alert-code-scanning-alertrenamed tocode-scanning-alert-rule - Breaking
Schema
code-scanning-analysis-refrenamed tocode-scanning-ref - Breaking
Schema
code-scanning-analysis-code-scanning-analysisrenamed tocode-scanning-analysis
Features
GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instancesGET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}.
Fixes
Improved parameter types and responses for code scanning endpoints
- 4.x
4.0.4
14 Feb 2021package: set
"types"to actual definition file, not typescript source file
4.0.3
12 Feb 2021Improved parameter and response types
4.0.2
10 Feb 2021group-mapping,full-repository,workflow-run-statustypes
4.0.1
3 Feb 2021Stop exporting a TypeScript file as
"main"field inpackage.json
4.0.0
2 Feb 2021- Breaking
interactions/get-restrictions-for-your-public-reposoperation is nowinteractions/get-restrictions-for-authenticated-user - Breaking
interactions/set-restrictions-for-your-public-reposoperation is nowinteractions/set-restrictions-for-authenticated-user - Breaking
interactions/remove-restrictions-for-your-public-reposoperation is nowinteractions/remove-restrictions-for-authenticated-user
Bug Fixes
Correct response types for
GET /user/emails. Adds missing response data type forPOST /markdown
Breaking changes
- Breaking
interactions/get-restrictions-for-your-public-reposoperation is nowinteractions/get-restrictions-for-authenticated-user - Breaking
interactions/set-restrictions-for-your-public-reposoperation is nowinteractions/set-restrictions-for-authenticated-user - Breaking
interactions/remove-restrictions-for-your-public-reposoperation is nowinteractions/remove-restrictions-for-authenticated-user
- 3.x
3.5.0
2 Feb 2021auto_mergeresponse data key and component
3.4.1
31 Jan 2021contextparameter description update
3.4.0
31 Jan 2021orderparameter forGET /enterprises/{enterprise}/audit-logandGET /orgs/{org}/audit-logoperations
3.3.0
26 Jan 2021Add descriptions to
members_can_create_pages,members_can_create_public_pages,members_can_create_private_pages(orgs/update)
3.2.1
25 Jan 2021authorized_credential_titleandauthorized_credential_notecan benull
3.2.0
22 Jan 2021POST /repos/{owner}/{repo}/branches/{branch}/rename
3.1.1
21 Jan 2021Improved response types
3.1.0
21 Jan 2021author_associationschema
3.0.0
21 Jan 2021- Breaking
gist-fullschema has been removed GET /orgs/{org}/failed_invitations(orgs/list-failed-invitations),DELETE /orgs/{org}/invitations/{invitation_id}(orgs/cancel-invitation)Several schema improvements, description fixes
- 2.x
2.3.1
18 Jan 2021Improved response types for
apps/create-installation-access-tokenoperation
2.3.0
15 Jan 2021POST /applications/{client_id}/token/scopedapp-permissionscomponent schema.Sets required keys for many objects
All changes from
Features
POST /applications/{client_id}/token/scopedapp-permissionscomponent schema.
Fixes
Sets required keys for many objects
Removes graduated
giant-sentry-fistpreviewCorrects documentation URLs in descriptions
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.