Skip to content

Releases: octokit/openapi-types.ts

v13.8.0

05 Sep 08:55
40cac8e

Choose a tag to compare

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 ) by head_sha
  • Tweak the recently-added state_reason attribute on issues to be a enum (completed, not_planned or reopened) rather than an unbounded string

v13.7.0

02 Sep 12:50
01faa14

Choose a tag to compare

13.7.0 (2022-09-02)

  • Add support for is_alphanumeric boolean 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_uri attribute 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_enabled boolean 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 302 as a potential response status code for GET /orgs/{org}/members, which hasn't been returned for nearly 8 years
  • Add 503 as a potential response status code across various API operations

v13.6.0

31 Aug 13:01
9e98afb

Choose a tag to compare

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_repositories and secret_scanning_push_protection_enabled_for_new_repositories read-write boolean attributes on organizations
  • Add support for new last_known_stop_notice attribute 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

30 Aug 13:13
96862f5

Choose a tag to compare

13.5.0 (2022-08-30)

  • Add support for sorting with sort and direction querystring parameters when listing a repo's code scanning analyses with GET /repos/{owner}/{repo}/code-scanning/analyses
  • Add support for default_branch_only boolean request body parameter when creating a fork with POST /repos/{owner}/{repo}/forks
  • Add support for state_reason request body parameter when updating an issue with PATCH /repos/{owner}/{repo}/issues/{issue_number}
  • Update description of GET /organizations/{organization_id}/custom_roles to 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

20 Aug 16:18
e0bdd1b

Choose a tag to compare

13.4.0 (2022-08-20)

Features

  • add web_commit_signoff_required request body parameter in POST /orgs/{org}/repos, PATCH /repos/{owner}/{repo} and PATCH /repos/{owner}/{repo}
  • add web_commit_signoff_required response attribute where repositories and organizations are returned in the API

v13.3.0

19 Aug 18:05
18a8faa

Choose a tag to compare

13.3.0 (2022-08-19)

Features

  • add squash_merge_commit_title, squash_merge_commit_message, merge_commit_title and merge_commit_message request body parameters in POST /orgs/{org}/repos, PATCH /repos/{owner}/{repo}, POST /user/repos
  • add squash_merge_commit_title, squash_merge_commit_message, merge_commit_title and merge_commit_message response attributes where repositories are returned in the API

v13.2.0

18 Aug 15:23
79f4aba

Choose a tag to compare

13.2.0 (2022-08-18)

Features

  • add new permissions.organization_custom_roles response attribute in GET /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/installations and GET /users/{username}/installation
  • add new permissions.organization_custom_roles request body parameter in POST /app/installations/{installation_id}/access_tokens and POST /applications/{client_id}/token/scoped

Bug Fixes

  • update description for manifests passed in request body to POST /repos/{owner}/{repo}/dependency-graph/snapshots

v13.1.0

16 Aug 12:37
c4ddcb2

Choose a tag to compare

13.1.0 (2022-08-16)

Features

  • add new Enterprise licenses APIs (GET /enterprises/{enterprise}/consumed-licenses, GET /enterprises/{enterprise}/license-sync-status) (#224) (c4ddcb2)

v13.0.1

15 Aug 12:23

Choose a tag to compare

13.0.1 (2022-08-15)

Bug Fixes

  • build: allow download script to handle more than 30 GitHub release assets (3bbf304)

v13.0.0

15 Aug 11:00

Choose a tag to compare

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-managersPUT /orgs/{org}/security-managers/teams/{team_slug} and DELETE /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 and retention_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 that target_url and description can be null
  • fix: correct describe the type of items returned by the GET /repos/{owner}/{repo}/contents/{path} API as enum (dir, file, submodule, symlink)
  • feat: add new added_by and last_used attributes on Deploy Keys returned across the API
  • fix: correct type of permission request body parameter for PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo} and PUT /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 and per_page parameters for GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers which are not actually supported
  • feat: add support for build_type parameter in POST /repos/{owner}/{repo}/pages and PUT /repos/{owner}/{repo}/pages
  • fix: mark that commit_id, path and line 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 that event must be sent to DISMISS