Releases: octokit/openapi-types.ts
Releases · octokit/openapi-types.ts
v13.8.0
13.8.0 (2022-09-05)
- Add support for filtering "List workflows runs for a repository" (
GET /repos/{owner}/{repo}/actions/runs) and "List workflow runs [for a workflow]" (GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs) byhead_sha - Tweak the recently-added
state_reasonattribute on issues to be a enum (completed,not_plannedorreopened) rather than an unbounded string
v13.7.0
13.7.0 (2022-09-02)
- Add support for
is_alphanumericboolean attribute for autolinks, accepted in the request body of the "Create an autolink reference for a repository" (POST /repos/{owner}/{repo}/autolinks) API and returned on autolinks across the API - Add support for
rule.help_uriattribute returned on code scanning alerts across the API (GET /enterprises/{enterprise}/code-scanning/alerts,GET /orgs/{org}/code-scanning/alerts,GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number},PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}) - Add support for long-standing
anonymous_access_enabledboolean attribute returned on repos across the API - Tweak documentation for "Create an autolink reference for a repository" (
POST /repos/{owner}/{repo}/autolinks) to read more smoothly - Clarify in documentation that the "Create a repository using a template" (
POST /repos/{template_owner}/{template_repo}/generate) doesn't require any special permissions with a public repo - Drop
302as a potential response status code forGET /orgs/{org}/members, which hasn't been returned for nearly 8 years - Add
503as a potential response status code across various API operations
v13.6.0
13.6.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_repositoriesandsecret_scanning_push_protection_enabled_for_new_repositoriesread-write boolean attributes on organizations - Add support for new
last_known_stop_noticeattribute on Codespace machines across the API - 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)
v13.5.0
13.5.0 (2022-08-30)
- Add support for sorting with
sortanddirectionquerystring parameters when listing a repo's code scanning analyses withGET /repos/{owner}/{repo}/code-scanning/analyses - Add support for
default_branch_onlyboolean request body parameter when creating a fork withPOST /repos/{owner}/{repo}/forks - Add support for
state_reasonrequest body parameter when updating an issue withPATCH /repos/{owner}/{repo}/issues/{issue_number} - Update description of
GET /organizations/{organization_id}/custom_rolesto clarify required permissions - Update description of
DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}to clarify how sets of analyses work - Update description for
GET /repos/{owner}/{repo}/contents/{path}to clarify that download links expire
v13.4.0
v13.3.0
13.3.0 (2022-08-19)
Features
- add
squash_merge_commit_title,squash_merge_commit_message,merge_commit_titleandmerge_commit_messagerequest body parameters inPOST /orgs/{org}/repos,PATCH /repos/{owner}/{repo},POST /user/repos - add
squash_merge_commit_title,squash_merge_commit_message,merge_commit_titleandmerge_commit_messageresponse attributes where repositories are returned in the API
v13.2.0
13.2.0 (2022-08-18)
Features
- add new
permissions.organization_custom_rolesresponse attribute inGET /app/installations,GET /app/installations/{installation_id},POST /app/installations/{installation_id}/access_tokens,POST /applications/{client_id}/token,PATCH /applications/{client_id}/token,POST /applications/{client_id}/token/scoped,GET /orgs/{org}/installation,GET /orgs/{org}/installations,GET /repos/{owner}/{repo}/installation,GET /user/installationsandGET /users/{username}/installation - add new
permissions.organization_custom_rolesrequest body parameter inPOST /app/installations/{installation_id}/access_tokensandPOST /applications/{client_id}/token/scoped
Bug Fixes
- update description for
manifestspassed in request body toPOST /repos/{owner}/{repo}/dependency-graph/snapshots
v13.1.0
v13.0.1
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/alertswith 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-statisticsto reflect that it returns an array of results - feat: add new
retention_period_minutesandretention_expires_atfields 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_urlanddescriptioncan benull - fix: correct describe the
typeof items returned by theGET /repos/{owner}/{repo}/contents/{path}API as enum (dir,file,submodule,symlink) - feat: add new
added_byandlast_usedattributes on Deploy Keys returned across the API - fix: correct type of
permissionrequest 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
pageandper_pageparameters forGET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewerswhich are not actually supported - feat: add support for
build_typeparameter inPOST /repos/{owner}/{repo}/pagesandPUT /repos/{owner}/{repo}/pages - fix: mark that
commit_id,pathandlineare in fact required for `POST /repos/{owner}/{repo}/pulls/{pull_number}/comments - fix: correct types for
POST /repos/{owner}/{repo}/pulls/{pull_number}/reviewsto reflect thateventmust be sent toDISMISS