Releases: octokit/openapi-types.ts
Releases · octokit/openapi-types.ts
v17.1.0
v17.0.0
v16.1.0
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-types
package. These will only appear in the GHEC-specific@octokit/openapi-types-ghec
package. The@octokit/openapi-types
package 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-ghec
package, 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_comment
attribute returned on secret scanning alerts - feat: add support for new
scope
attribute 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}/starred
andGET /user/starred
) to clarify whatAccept
header 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
size
attribute returned on repos across the API - fix: document that APIs can return
422
errors when an endpoint has been spammed with many requests - fix: document
301
status returned by labels-related APIs if the repo has been renamed or moved - fix: document
404 Not Found
status 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 security
toGitHub Advanced Security
in descriptions - fix: update docs for the "Update a secret scanning alert" API (
PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}
) to clarify that aresolution
must be provided when settingstate
toresolved
- fix: use
enum
s rather thanstring
types with a list of accepted values in thedescription
(e.g. theconclusion
attribute returned in the "Get a job for a workflow run" API [GET /repos/{owner}/{repo}/actions/jobs/{job_id}
])