Releases: octokit/openapi-types.ts
Releases · octokit/openapi-types.ts
v16.0.0
v15.0.0
v13.13.1
v14.0.0
14.0.0 (2022-09-27)
BREAKING CHANGES
- Types for API operations only available to GitHub Enterprise Cloud (GHEC) customers will no longer appear in the
@octokit/openapi-typespackage. These will only appear in the GHEC-specific@octokit/openapi-types-ghecpackage. The@octokit/openapi-typespackage now only includes APIs available to customers on GitHub.com using the Free, Pro and Teams plans.
Features
- feat: publish new GitHub Enterprise Cloud (GHEC) specific
@octokit/openapi-types-ghecpackage, plus lots of API changes (29539cf) - feat: add support for new "Get a Dependabot alert" API (
GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number}) - feat: add support for new "Update a Dependabot alert" API (
PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number}) - feat: 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
- feat: add support for new "List organization secret" (
- feat: add support for new "Get an organization public key" (
GET /organizations/{org}/codespaces/secrets/public-key) Codespaces API - feat: add support for new "Get an organization secret" (
GET /organizations/{org}/codespaces/secrets/{secret_name}) Codespaces API - feat: adds support for new "Create or update an organization secret" (
PUT /organizations/{org}/codespaces/secrets/{secret_name}) Codespaces API - feat: add support for new "Delete an organization secret" (
DELETE /organizations/{org}/codespaces/secrets/{secret_name}) Codespaces API - feat: add support for new "List selected repositories for an organization secret" (
GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories) Codespaces API - feat: add support for new "Set selected repositories for an organization secret" (
PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories) Codespaces API - feat: add support for new "Add selected repository to an organization secret" (
PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}) Codespaces API - feat: add support for new "Remove selected repository from an organization secret" (
DELETE /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}) Codespaces API - feat: add support for
resolution_commentattribute returned on secret scanning alerts - feat: add support for new
scopeattribute returned by the "Get a diff of the dependencies between commits" (GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}) API
### Fixes
- fix: tweak documentation for repo starring related APIs (
GET /repos/{owner}/{repo}/stargazers,GET /users/{username}/starredandGET /user/starred) to clarify whatAcceptheader to send to get information about when stars were created - fix: 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 - fix: document the
sizeattribute returned on repos across the API - fix: document that APIs can return
422errors when an endpoint has been spammed with many requests - fix: document
301status returned by labels-related APIs if the repo has been renamed or moved - fix: document
404 Not Foundstatus returned by labels-related APIs
v13.13.0
This version was published accidentally as a minor version, when it should have been a major version.
v13.12.0
v13.11.0
13.11.0 (2022-09-15)
- feat: add new "List CodeQL databases for a repository" API (
GET /repos/{owner}/{repo}/code-scanning/codeql/databases) - feat: add new "Get a CodeQL database for a repository" API (
GET /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}) - fix: 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 - fix: correct casing of
github advanced securitytoGitHub Advanced Securityin descriptions - fix: 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 - fix: 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}])
v13.10.0
13.10.0 (2022-09-13)
- feat: 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 - feat: add support for filtering the "List repository collaborators" API (
GET /repos/{owner}/{repo}/collaborators) bypermissionusing a query param - fix: update type documentation to flag the "List enterprise consumed licenses" API (
GET /enterprises/{enterprise}/consumed-licenses) as beta - fix: clarify in type documentation that the "Get or update file contents" API (
PUT /repos/{owner}/{repo}/contents/{path}) requires theworkflowscope - fix: adding missing type documentation for the "List repository webhooks" API (
GET /repos/{owner}/{repo}/hooks)
v13.9.1
v13.9.0
13.9.0 (2022-09-07)
- feat: 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) - feat: add support for new
description,base_role,permissions,organization,created_atandupdated_atfields where custom repo roles are returned in the API - fix: 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...") - fix: mark
use_squash_pr_title_as_defaultattribute on repos as deprecated in favour ofsquash_merge_commit_title - fix: 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" - fix: correct description of
sharequest body parameter in the "Delete a file" API (DELETE /repos/{owner}/{repo}/contents/{path})