Releases: octokit/types.ts
Releases · octokit/types.ts
v8.0.0
8.0.0 (2022-10-12)
BREAKING CHANGES
@octokit/types
no longer include endpoint types for GHEC
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 - deps: update
@octokit/openapi-types
to v14 (#463) (7bf7e20)
### 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
v7.5.1
v7.5.0
v7.4.0
v7.3.1
v7.3.0
7.3.0 (2022-09-07)
Features
v7.2.0
7.2.0 (2022-08-31)
Features
- Add support for new "Enable or disable a security feature for an organization" API (
POST /orgs/{org}/{security_product}/{enablement}
) - Add support for new
advanced_security_enabled_for_new_repositories
,dependabot_alerts_enabled_for_new_repositories
,dependabot_security_updates_enabled_for_new_repositories
,dependency_graph_enabled_for_new_repositories
,secret_scanning_enabled_for_new_repositories
andsecret_scanning_push_protection_enabled_for_new_repositories
boolean parameters when updating an organization withPATCH /orgs/:id
- Add support for sorting with
sort
anddirection
querystring parameters when listing a repo's code scanning analyses withGET /repos/{owner}/{repo}/code-scanning/analyses
- Add support for
default_branch_only
boolean request body parameter when creating a fork withPOST /repos/{owner}/{repo}/forks
- Add support for
state_reason
request body parameter when updating an issue withPATCH /repos/{owner}/{repo}/issues/{issue_number}
- Add support for new SSH signing keys APIs (
GET /user/ssh_signing_keys
,POST /user/ssh_signing_keys
,GET /user/ssh_signing_keys/{ssh_signing_key_id}
,DELETE /user/ssh_signing_keys/{ssh_signing_key_id}
,GET /users/{username}/ssh_signing_keys
)
v7.1.1
v7.1.0
v7.0.0
7.0.0 (2022-08-15)
Bug Fixes
Features
- add new deployment branch policy APIs (
GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies
, `POST (5e206cf) - add new GitHub Pages (
POST /repos/{owner}/{repo}/pages/deployment
) API (8d414ed) - add new Security Managers APIs (
GET /orgs/{org}/security-managers
,PUT /orgs/{org}/security-managers/teams/{team_slug}
andDELETE /orgs/{org}/security-managers/teams/{team_slug}
) (0d21aa3)
BREAKING CHANGES
- This removes the now-defunkt OAuth Authorizations
APIs from the OpenAPI specifications. These were disabled and cut
off on GitHub.com at the end of 2020, but the docs were not
updated.