Skip to content

Releases: octokit/openapi

v7.12.1

14 Sep 12:28
cb05d6e
Compare
Choose a tag to compare

7.12.1 (2022-09-14)

Bug Fixes

  • Update description 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
  • Update a number of APIs to use enums to describe allowed values, rather than string types with a list of 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}])

v7.12.0

13 Sep 12:18
58951a7
Compare
Choose a tag to compare

7.12.0 (2022-09-13)

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

v7.11.0

09 Sep 12:26
Compare
Choose a tag to compare

7.11.0 (2022-09-09)

  • feat: allow key pattern for the "Create a SSH signing key for the authenticated user" API (POST /user/ssh_signing_keys) to allow physical security keys
  • fix: 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
  • fix: mark the path parameter for the base and head branch to compare in the "Compare two commits" API (GET repos/{owner}/{repo}/compare/{basehead}) as multi-segment
  • fix: document allowed response statuses for the "Update a team" API (PATCH /orgs/{org}/teams/{team_slug})

v7.10.0

07 Sep 12:33
161e014
Compare
Choose a tag to compare

7.10.0 (2022-09-07)

  • Add new public beta APIs for creating, reading, updating and deleting custom repo roles (POST /orgs/{org}/custom_roles, PATCH /orgs/{org}/custom_roles/{role_id}, DELETE /orgs/{org}/custom_roles/{role_id}, GET /orgs/{org}/fine_grained_permissions)
  • Add new description, base_role, permissions, organization, created_at and updated_attributes where custom repo roles are returned in the API
  • Rename APIs for listing package versions (e.g. GET /orgs/{org}/packages/{package_type}/{package_name}/versions) to clarify that they returned paginated lists ("Get all..." -> "List...")
  • Mark use_squash_pr_title_as_default attribute on repos as deprecated in favour of squash_merge_commit_title
  • Rename "List workflow runs" (GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs) API to the more indicative "List workflow runs for a workflow"
  • Correct description of sha request body parameter in the "Delete a file" API (DELETE /repos/{owner}/{repo}/contents/{path})

v7.9.1

06 Sep 13:21
a0958e3
Compare
Choose a tag to compare

7.9.1 (2022-09-06)

Bug Fixes

  • update examples for Codespace machines in an API response (#287) (a0958e3)

v7.9.0

05 Sep 08:47
e815e2d
Compare
Choose a tag to compare

7.9.0 (2022-09-05)

  • allow 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

v7.8.0

02 Sep 12:40
a90a849
Compare
Choose a tag to compare

7.8.0 (2022-09-02)

Features

  • add is_alphanumeric boolean attribute, 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 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})
  • tweak documentation for "Create an autolink reference for a repository" (POST /repos/{owner}/{repo}/autolinks)
  • clarify in documentation that the "Create a repository using a template" (POST /repos/{template_owner}/{template_repo}/generate) doesn't require special permissions with a public repo
  • document long-standing anonymous_access_enabled boolean attribute returned on repos in the API
  • add 503 as a potential response status code across various API operations
  • drop 302 as a potential response status code for GET /orgs/{org}/members, which hasn't been returned for nearly 8 years

v7.7.0

31 Aug 12:48
beac635
Compare
Choose a tag to compare

7.7.0 (2022-08-31)

Features

  • Add new "Enable or disable a security feature for an organization" API (POST /orgs/{org}/{security_product}/{enablement})
  • Add 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 new last_known_stop_notice attribute on Codespace machines across the API
  • Add 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)

v7.6.0

30 Aug 12:44
6c878d3
Compare
Choose a tag to compare

7.6.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

v7.5.0

20 Aug 16:11
4507f4a
Compare
Choose a tag to compare

7.5.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