Releases: octokit/openapi-types.ts
Releases · octokit/openapi-types.ts
v12.5.0
12.5.0 (2022-06-28)
- feat:
PUT /enterprises/{enterprise}/actions/oidc/customization/issuer
- feat:
GET /orgs/{org_id}/codespaces
- feat:
POST /orgs/{org}/members/{username}/codespaces/{codespace_name}/stop
- feat:
GET /orgs/{org}/actions/oidc/customization/sub
- feat:
PUT /orgs/{org}/actions/oidc/customization/sub
- feat:
DELETE /orgs/{org}/members/{username}/codespaces/{codespace_name}
- fix: Add additional examples and error response codes
- feat:
GET /repos/{owner}/{repo}/actions/caches
- feat:
DELETE /repos/{owner}/{repo}/actions/caches
- feat:
DELETE /repos/{owner}/{repo}/actions/caches/{cache_id}
- feat:
GET /repos/{owner}/{repo}/actions/oidc/customization/sub
- feat:
PUT /repos/{owner}/{repo}/actions/oidc/customization/sub
- feat: support for optional
retention_period_minutes
request body parameter inPOST /repos/{owner}/{repo}/codespaces
,POST /repos/{owner}/{repo}/pulls/{pull_number}/codespaces
andPOST /user/codespaces
- fix: mark
POST /repos/{owner}/{repo}/dependency-graph/snapshots
as available on GitHub.com, not just GitHub Enterprise Cloud - fix: mark
assignees
request body parameter - and the request body more generally - as required inDELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees
- fix: remove no longer supported
GET /repos/{owner}/{repo}/community/code_of_conduct
API
v12.4.0
v12.3.0
v12.2.0
v12.1.0
Features
{GET,DELETE} /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}
{GET,PATCH,DELETE} /orgs/{org}/teams/{team_slug}/external-groups
{GET,POST,PUT,DELETE} /enterprises/{enterprise}/actions/runners/{runner_id}/labels"
{GET,POST,PUT,DELETE} /orgs/{org}/actions/runners/{runner_id}/labels
{GET,POST,PUT,DELETE} /repos/{owner}/{repo}/actions/runners/{runner_id}/labels
{GET,POST} /repos/{owner}/{repo}/codespaces
{GET,POST} /repos/{owner}/{repo}/tags/protection
{GET,POST} /user/codespaces
,GET /user/codespaces/secrets
,GET /user/codespaces/secrets/public-key
,{GET,PUT,DELETE} /user/codespaces/secrets/{secret_name}
,{GET,PUT} /user/codespaces/secrets/{secret_name}/repositories
,{PUT,DELETE} /user/codespaces/secrets/{secret_name}/repositories/{repository_id}
,{GET,PATCH,DELETE} /user/codespaces/{codespace_name}
,POST /user/codespaces/{codespace_name}/exports
,GET /user/codespaces/{codespace_name}/exports/{export_id}
,GET /user/codespaces/{codespace_name}/machines
,POST /user/codespaces/{codespace_name}/start
,POST /user/codespaces/{codespace_name}/stop
{GET,PUT,DELETE} /orgs/{org}/dependabot/secrets/{secret_name}
{GET,PUT,DELETE} /repos/{owner}/{repo}/codespaces/secrets/{secret_name}
{GET,PUT,DELETE} /repos/{owner}/{repo}/dependabot/secrets/{secret_name}
{GET,PUT} /orgs/{org}/actions/permissions/workflow
{GET,PUT} /orgs/{org}/dependabot/secrets/{secret_name}/repositories
{GET,PUT} /repos/{owner}/{repo}/actions/permissions/access
{GET,PUT} /repos/{owner}/{repo}/actions/permissions/workflow
/organizations/{organization_id}/custom_roles
/orgs/{org}/actions/cache/usage
DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}
DELETE /orgs/{org}/actions/runners/{runner_id}/labels/{name}
DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}
DELETE /repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}
DELETE /repos/{owner}/{repo}/tags/protection/{tag_protection_id}
GET /enterprise-installation/{enterprise_or_org}/server-statistics
GET /enterprises/{enterprise}/actions/cache/usage
GET /enterprises/{enterprise}/actions/permissions/workflow
GET /enterprises/{enterprise}/actions/runner-groups
-visible-to-organization
paramterGET /enterprises/{enterprise}/secret-scanning/alerts
GET /enterprises/{enterprise}/settings/billing/advanced-security
GET /orgs/{org}/actions/cache/usage-by-repository
GET /orgs/{org}/actions/runner-groups
- new parameter:visible_to_repository
GET /orgs/{org}/code-scanning/alerts
GET /orgs/{org}/credential-authorizations
- new parameters:per_page
,page
,login
GET /orgs/{org}/dependabot/secrets/public-key
GET /orgs/{org}/dependabot/secrets
GET /orgs/{org}/external-group/{group_id}
GET /orgs/{org}/external-groups
GET /orgs/{org}/secret-scanning/alerts
- new parameters:sort
,direction
GET /orgs/{org}/settings/billing/advanced-security
GET /repos/{owner}/{repo}/codeowners/errors
GET /repos/{owner}/{repo}/codespaces/devcontainers
GET /repos/{owner}/{repo}/codespaces/machines
GET /repos/{owner}/{repo}/codespaces/secrets/public-key
GET /repos/{owner}/{repo}/codespaces/secrets
GET /repos/{owner}/{repo}/dependabot/secrets/public-key
GET /repos/{owner}/{repo}/dependabot/secrets
GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}
GET /repos/{owner}/{repo}/releases/{release_id}/reactions
GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations
PATCH /orgs/{org}/actions/runner-groups/{runner_group_id}
- new parameters:allows_public_repositories
,restricted_to_workflows
,selected_workflows
PATCH /orgs/{org}
- new parameter:members_can_fork_private_repositories
POST /orgs/{org}/actions/runner-groups
- new parameters:allows_public_repositories
,restricted_to_workflows
,selected_workflows
POST /orgs/{org}/migrations
- new parrameters:exclude_metadata
,exclude_git_data
,org_metadata_only
POST /orgs/{org}/repos
- new parameter:use_squash_pr_title_as_default
POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun
POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs
POST /repos/{owner}/{repo}/pulls/{pull_number}/codespaces
POST /user/migrations
- new parrameters:exclude_metadata
,exclude_git_data
,org_metadata_only
PUT /enterprises/{enterprise}/actions/permissions/workflow
PUT /orgs/{org}/outside_collaborators/{username}
- new parameter:async
GET /repos/{owner}/{repo}/actions/cache/usage
GET /repos/{owner}/{repo}/actions/runs
: new parameter:check_suite_id
GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs
: new parameter:check_suite_id
GET /repos/{owner}/{repo}/code-scanning/alerts
: new parameters:direction
,sort
GET /repos/{owner}/{repo}/environments
: new parameters:per_page
,page
GET /repos/{owner}/{repo}/secret-scanning/alerts
: new parameters:direction
,sort
PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews
: new parameters:dismissal_restrictions.apps
,bypass_pull_request_allowances
PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks
: new parameter:checks
PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}
: new parameter:dismissed_comment
PATCH /repos/{owner}/{repo}
:secret_scanning_push_protection
,use_squash_pr_title_as_default
POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun
: new parameter:enable_debug_logging
POST /user/gpg_keys
: new parameter:name
PUT /repos/{owner}/{repo}/branches/{branch}/protection
: new parameter:required_status_checks.checks
,required_pull_request_reviews.{apps,bypass_pull_request_allowances}
,block_creations
- updated
components.parameters
- components:
repository.{allow_update_branch,use_squash_pr_title_as_default,use_squash_pr_title_as_default}
server-statistics
actions-default-workflow-permissions
actions-can-approve-pull-request-reviews
actions-get-default-workflow-permissions
actions-set-default-workflow-permissions
runner-groups-enterprise.{workflow_restrictions_read_only,restricted_to_workflows,selected_workflows}
runner-label
nullable-alert-updated-at
minimal-repository
actions-billing-usage.minutes_used_breakdown.{linux_4_core,linux_8_core,linux_16_core,linux_32_core,linux_64_core,windows_4_core,windows_8_core,windows_16_core,windows_32_core,windows_64_core,total}
advanced-security-active-committers-user
advanced-security-active-committers-repository
advanced-security-active-committers
issue.state_reason
issue.draft
api-overview.ssh-keys
organization-custom-repository-role
actions-cache-usage-by-repository
runner-groups-org.{workflow_restrictions_read_only,restricted_to_workflows,selected_workflows}
code-scanning-alert-state
alert-updated-at
code-scanning-alert-fixed-at
code-scanning-alert-dismissed-comment
code-scanning-alert-rule
code-scanning-organization-alert-items
credential-authorization.authorized_credential_expires_at
organization-dependabot-secret
dependabot-public-key
external-group
external-groups
migration.org_metadata_only
nullable-minimal-repository.role_name
team-repository.role_name
rate-limit-overview.scim
security-and-analysis
full-repository.use_squash_pr_title_as_default
artifact.workflow_run
actions-workflow-access-to-repository
referenced_workflow
workflowrun.{path,referenced_workflows,actor,triggering_actor}
protected-branch-required-status-check
protected-branch-pull-request-review.{dismissal_restrictions.apps,bypass_pull_request_allowances}
branch-protection.block_creations
status-check-policy.checks
protected-branch.{dismissal_restrictions.apps,bypass_pull_request_allowances,block_creations}
check-suite.{rerequestable,runs_rerequestable}
code-scanning-alert-rule-summary.tags
code-scanning-alert-items.{updated_at,fixed_at,dismissed_comment}
code-scanning-sarifs-status.errors
nullable-codespace-machine
codespace
codespace-machine
repo-codespaces-secret
codespaces-public-key
collaborator.role_name
nullable-collaborator
dependabot-secret
nullable-issue
state-change-issue-event
timeline-issue-events
can be of typestate-change-issue-event
page.build_type
secret-scanning-alert.{updated_at,secret_type_display_name}
secret-scanning-location-commit
tag-protection
issue-search-result-item.state_reason
codespaces-secret
gpg-key.{name,revoked}
Bug Fixes
POST /app-manifests/{code}/conversions
has no request bodyGET /projects/{project_id}/collaborators/{username}/permission
: correct response type and examplePATCH /repos/{owner}/{repo}
:visibility
parameter cannot be set tovisibility
POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun
: no longer deprecated- remove defunkt
DELETE /reactions/{reaction_id}
- remove defunkt
POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments
v12.0.0
v11.2.0
v11.1.0
v11.0.0
11.0.0 (2021-10-07)
Features
GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_num}
,GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_num}/logs
,POST /repos/{owner}/{repo}/releases/generate-notes
,POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest
. Graduatenebula
,zzzax
,switcheroo
,baptiste
previews. Removes defunkt/repos/{owner}/{repo}/actions/runs/{run_id}/retry
endpoint. Renames operation IDs to normalize-authenticated-user
suffix (#172) (ae60215)
BREAKING CHANGES
- Operation ID
users/list-blocked-by-authenticated
is nowusers/list-blocked-by-authenticated-user
- Operation ID
users/set-primary-email-visibility-for-authenticated
is nowusers/set-primary-email-visibility-for-authenticated-user
- Operation ID
users/list-emails-for-authenticated
is nowusers/list-emails-for-authenticated-user
- Operation ID
users/add-email-for-authenticated
is nowusers/add-email-for-authenticated-user
- Operation ID
users/delete-email-for-authenticated
is nowusers/delete-email-for-authenticated-user
- Operation ID
users/list-followed-by-authenticated
is nowusers/list-followed-by-authenticated-user
- Operation ID
users/list-gpg-keys-for-authenticated
is nowusers/list-gpg-keys-for-authenticated-user
- Operation ID
users/create-gpg-key-for-authenticated
is nowusers/create-gpg-key-for-authenticated-user
- Operation ID
users/get-gpg-key-for-authenticated
is nowusers/get-gpg-key-for-authenticated-user
- Operation ID
users/delete-gpg-key-for-authenticated
is nowusers/delete-gpg-key-for-authenticated-user
- Operation ID
apps/add-repo-to-installation
is nowapps/add-repo-to-installation-for-authenticated-user
- Operation ID
apps/remove-repo-from-installation
is nowapps/remove-repo-from-installation-for-authenticated-user
- Operation ID
users/list-public-ssh-keys-for-authenticated
is nowusers/list-public-ssh-keys-for-authenticated-user
- Operation ID
users/create-public-ssh-key-for-authenticated
is nowusers/create-public-ssh-key-for-authenticated-user
- Operation ID
users/get-public-ssh-key-for-authenticated
is nowusers/get-public-ssh-key-for-authenticated-user
- Operation ID
users/delete-public-ssh-key-for-authenticated
is nowusers/delete-public-ssh-key-for-authenticated-user
- Operation ID
migrations/list-repos-for-user
is nowmigrations/list-repos-for-authenticated-user
- Operation ID
users/list-public-emails-for-authenticated
is nowusers/list-public-emails-for-authenticated-user
- Operation ID
repos/accept-invitation
is nowrepos/accept-invitation-for-authenticated-user
- Operation ID
repos/decline-invitation
is nowrepos/decline-invitation-for-authenticated-user