Skip to content

Releases: octokit/openapi-types.ts

v16.1.0

19 Apr 23:42
cdd5d27
Compare
Choose a tag to compare

16.1.0 (2023-04-19)

Features

v16.0.0

19 Jan 23:21
0b1ad10
Compare
Choose a tag to compare

16.0.0 (2023-01-19)

Features

BREAKING CHANGES

  • removes GHES 3.3 support as it was deprecated recently

v15.0.0

19 Jan 23:03
040e742
Compare
Choose a tag to compare

15.0.0 (2023-01-19)

Features

BREAKING CHANGES

v13.13.1

29 Sep 17:14
ed9a411
Compare
Choose a tag to compare

13.13.1 (2022-09-29)

Bug Fixes

  • revert "feat: publish new GitHub Enterprise Cloud (GHEC) specific @octokit/openapi-types-ghec package, plus lots of API changes (#251)" (#255) (ed9a411)

v14.0.0

27 Sep 16:33
29539cf
Compare
Choose a tag to compare

14.0.0 (2022-09-27)

BREAKING CHANGES

  • Types for API operations only available to GitHub Enterprise Cloud (GHEC) customers will no longer appear in the @octokit/openapi-types package. These will only appear in the GHEC-specific @octokit/openapi-types-ghec package. The @octokit/openapi-types package now only includes APIs available to customers on GitHub.com using the Free, Pro and Teams plans.

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 "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

### Fixes

  • fix: tweak documentation for repo starring related APIs (GET /repos/{owner}/{repo}/stargazers, GET /users/{username}/starred and GET /user/starred) to clarify what Accept 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

v13.13.0

27 Sep 15:46
2805e56
Compare
Choose a tag to compare

This version was published accidentally as a minor version, when it should have been a major version.

v13.12.0

16 Sep 17:24
8fc4146
Compare
Choose a tag to compare

13.12.0 (2022-09-16)

Features

  • add support for new display_title attribute returned on workflow runs across the API (e.g. in GET /repos/{owner}/{repo}/actions/runs) (#247) (8fc4146)

v13.11.0

15 Sep 13:46
ff50f18
Compare
Choose a tag to compare

13.11.0 (2022-09-15)

  • feat: add new "List CodeQL databases for a repository" API (GET /repos/{owner}/{repo}/code-scanning/codeql/databases)
  • feat: add new "Get a CodeQL database for a repository" API (GET /repos/{owner}/{repo}/code-scanning/codeql/databases/{language})
  • fix: update descriptions for "Create or update file contents" (PUT /repos/{owner}/{repo}/contents/{path}) and "Delete a file" (DELETE /repos/{owner}/{repo}/contents/{path}) APIs to clarify that calling them in parallel may lead to conflicts
  • fix: correct casing of github advanced security to GitHub Advanced Security in descriptions
  • fix: update docs for the "Update a secret scanning alert" API (PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}) to clarify that a resolution must be provided when setting state to resolved
  • fix: use enums rather than string types with a list of accepted values in the description (e.g. the conclusion attribute returned in the "Get a job for a workflow run" API [GET /repos/{owner}/{repo}/actions/jobs/{job_id}])

v13.10.0

13 Sep 12:37
b40d8ef
Compare
Choose a tag to compare

13.10.0 (2022-09-13)

  • feat: add support for new github_com_enterprise_roles attribute returned by the "List enterprise consumed licenses" API (GET /enterprises/{enterprise}/consumed-licenses), marking the old singular github_com_enterprise_role attribute as deprecated
  • feat: add support for filtering the "List repository collaborators" API (GET /repos/{owner}/{repo}/collaborators) by permission using a query param
  • fix: update type documentation to flag the "List enterprise consumed licenses" API (GET /enterprises/{enterprise}/consumed-licenses) as beta
  • fix: clarify in type documentation that the "Get or update file contents" API (PUT /repos/{owner}/{repo}/contents/{path}) requires the workflow scope
  • fix: adding missing type documentation for the "List repository webhooks" API (GET /repos/{owner}/{repo}/hooks)

v13.9.1

09 Sep 12:33
11d4f33
Compare
Choose a tag to compare

13.9.1 (2022-09-09)

Bug Fixes

  • tweak description for "Get a tree" API (GET /repos/{owner}/{repo}/git/trees/{tree_sha}) to clarify maximum limits on size and number of entries and document allowed response statuses for the "Update a team" API (PATCH /orgs/{org}/teams/{team_slug}) (#242) (11d4f33)