Releases: octokit/openapi-types.ts
Releases · octokit/openapi-types.ts
v13.0.0
13.0.0 (2022-08-15)
BREAKING CHANGES
- This removes support for the now-defunkt OAuth Authorizations APIs. These were disabled on GitHub.com at the end of 2020, but the OpenAPI specs were not updated so this code was not cleaned up.
Other changes
- fix: document the required scopes to use
GET /orgs/{org}/code-scanning/alerts
with public repos - feat: 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}
) - feat: add new deployment branch policy APIs (
GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies
,POST /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies
,GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}
,PUT /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}
,DELETE /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}
) - feat: add new GitHub Pages API (
POST /repos/{owner}/{repo}/pages/deployment
) - fix: correct types for
GET /enterprise-installation/{enterprise_or_org}/server-statistics
to reflect that it returns an array of results - feat: add new
retention_period_minutes
andretention_expires_at
fields returned on Codespaces - fix: correct types for Commit Statuses in the API (e.g. returned by
POST /repos/{owner}/{repo}/statuses/{sha}
) to reflect thattarget_url
anddescription
can benull
- fix: correct describe the
type
of items returned by theGET /repos/{owner}/{repo}/contents/{path}
API as enum (dir
,file
,submodule
,symlink
) - feat: add new
added_by
andlast_used
attributes on Deploy Keys returned across the API - fix: correct type of
permission
request body parameter forPUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}
andPUT /repos/{owner}/{repo}/collaborators/{username}
to reflect that custom role names can be specified, not just values in a GitHub-set enum - fix: remove
page
andper_page
parameters forGET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
which are not actually supported - feat: add support for
build_type
parameter inPOST /repos/{owner}/{repo}/pages
andPUT /repos/{owner}/{repo}/pages
- fix: mark that
commit_id
,path
andline
are in fact required for `POST /repos/{owner}/{repo}/pulls/{pull_number}/comments - fix: correct types for
POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews
to reflect thatevent
must be sent toDISMISS
v12.11.0
v12.10.1
v12.10.0
v12.9.1
v12.9.0
12.9.0 (2022-07-13)
- feat: improve operation descriptions when an API operation is not available in a particular context (e.g. GHAE or a GHES version)
- feat: improve parameter descriptions for
POST /authorizations
,PUT /authorizations/clients/{client_id}
andPUT /authorizations/clients/{client_id}/{fingerprint}
- feat: add type annotations with
example
s and annotations about strings'format
s, where available - chore: update cached OpenAPI specs in
cache/
v12.8.0
v12.7.0
12.7.0 (2022-07-04)
- add support for specifying a
name
for the forked repository when creating a fork withPOST /repos/{owner}/{repo}/forks
(f300f8a) - when a SARIF response is explicitly requested from
GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}
, handle it as JSON - mark
sort
bynumber
forGET /repos/{owner}/{repo}/code-scanning/alerts
as deprecated
v12.6.1
v12.6.0
12.6.0 (2022-07-01)
- fix: mark
assignees
and request body as required in theDELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees
(i.e. remove assignees from an issue) API - fix: remove defunkt
GET /repos/{owner}/{repo}/community/code_of_conduct
API - chore: update some descriptions
- fix: allow
selected_repository_ids
forPUT /orgs/{org}/actions/secrets/{secret_name}
ANDPUT /orgs/{org}/dependabot/secrets/{secret_name}
to be integers or strings - fix: remove unused
prebuild_availability
enum values (blob
,pool
) for Codespaces machines - chore: rename refs to use dash-separated rather than underscore_separated names
- feat: add for
is_alphanumeric
boolean response attribute toGET /repos/{owner}/{repo}/autolinks
,POST /repos/{owner}/{repo}/autolinks
andGET /repos/{owner}/{repo}/autolinks/{autolink_id}