Skip to content

Releases: octokit/openapi-types.ts

v13.0.0

15 Aug 11:00
Compare
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

v12.11.0

27 Jul 16:46
a173f4b
Compare
Choose a tag to compare

12.11.0 (2022-07-27)

Features

  • new GET /enterprises/{enterprise}/code-scanning/alerts endpoint and description updates for multiple other endpoints (#215) (a173f4b)

v12.10.1

18 Jul 12:28
0257255
Compare
Choose a tag to compare

12.10.1 (2022-07-18)

Bug Fixes

  • add example for use_squash_pr_title_as_default property when repositories are returned in the API (#211) (0257255)

v12.10.0

15 Jul 12:58
8da5974
Compare
Choose a tag to compare

12.10.0 (2022-07-15)

Features

  • Add new GET /repos/{owner}/{repo}/codespaces/new API operation
  • Update operation parameter descriptions, operation descriptions and response examples

v12.9.1

14 Jul 20:27
91e1aaa
Compare
Choose a tag to compare

12.9.1 (2022-07-14)

Bug Fixes

  • improve parameter descriptions for GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers (#205) (91e1aaa)

v12.9.0

13 Jul 16:33
d4826cf
Compare
Choose a tag to compare

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 /authorizationsPUT /authorizations/clients/{client_id} and PUT /authorizations/clients/{client_id}/{fingerprint}
  • feat: add type annotations with examples and annotations about strings' formats, where available
  • chore: update cached OpenAPI specs in cache/

v12.8.0

05 Jul 16:32
d402a68
Compare
Choose a tag to compare

12.8.0 (2022-07-05)

  • feat: add support for returning dependency_snapshots-specific rate limits in GET /rate_limit
  • fix: clarify description to make it clear that POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments is only available to required reviewers

v12.7.0

04 Jul 20:43
Compare
Choose a tag to compare

12.7.0 (2022-07-04)

  • add support for specifying a name for the forked repository when creating a fork with POST /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 by number for GET /repos/{owner}/{repo}/code-scanning/alerts as deprecated

v12.6.1

02 Jul 17:28
b367a85
Compare
Choose a tag to compare

12.6.1 (2022-07-02)

Bug Fixes

  • don't mark endpoints as unavailable in GHES 3.5 and GHAE which are in fact available (#191) (b367a85)

v12.6.0

01 Jul 11:29
ff9ee2f
Compare
Choose a tag to compare

12.6.0 (2022-07-01)

  • fix: mark assignees and request body as required in the DELETE /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 for PUT /orgs/{org}/actions/secrets/{secret_name} AND PUT /orgs/{org}/dependabot/secrets/{secret_name} to be integers or strings
  • fix: remove unused prebuild_availability enum values (blobpool) for Codespaces machines
  • chore: rename refs to use dash-separated rather than underscore_separated names
  • feat: add for is_alphanumeric boolean response attribute to GET /repos/{owner}/{repo}/autolinks, POST /repos/{owner}/{repo}/autolinks and GET /repos/{owner}/{repo}/autolinks/{autolink_id}