@octokit/openapi-types
29.0.1 · 29 Aug 2026MIT97.2M / weekRepositoryHomepagenpmAtom feed
162 stable releases, newest first, by release line. Notes are quoted as the maintainers published them.
- 29.x · latest line
29.0.1
29 Aug 2026Remove empty requestBody
29.0.0
27 Aug 2026- Deprecated
GET /assignments/{assignment_id}/grades
- Deprecated
GET /classrooms
- Deprecated
GET /classrooms/{classroom_id}
What's Changed
New Endpoints
GET /agents/repos/{owner}/{repo}/tasks
POST /agents/repos/{owner}/{repo}/tasks
GET /agents/repos/{owner}/{repo}/tasks/{task_id}
GET /agents/tasks
GET /agents/tasks/{task_id}
GET /enterprises/{enterprise}/actions/oidc/customization/properties/repo
POST /enterprises/{enterprise}/actions/oidc/customization/properties/repo
DELETE /enterprises/{enterprise}/actions/oidc/customization/properties/repo/{custom_property_name}
GET /enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day
GET /enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest
GET /enterprises/{enterprise}/copilot/metrics/reports/repos-1-day
GET /enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day
GET /enterprises/{enterprise}/copilot/metrics/reports/users-1-day
GET /enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest
PUT /enterprises/{enterprise}/copilot/policies/coding_agent
POST /enterprises/{enterprise}/copilot/policies/coding_agent/organizations
DELETE /enterprises/{enterprise}/copilot/policies/coding_agent/organizations
GET /enterprises/{enterprise}/dependabot/repository-access
PATCH /enterprises/{enterprise}/dependabot/repository-access
PUT /enterprises/{enterprise}/dependabot/repository-access/default-level
GET /organizations/{org}/settings/billing/ai_credit/usage
GET /orgs/{org}/actions/oidc/customization/properties/repo
POST /orgs/{org}/actions/oidc/customization/properties/repo
DELETE /orgs/{org}/actions/oidc/customization/properties/repo/{custom_property_name}
GET /orgs/{org}/agents/secrets
GET /orgs/{org}/agents/secrets/public-key
GET /orgs/{org}/agents/secrets/{secret_name}
PUT /orgs/{org}/agents/secrets/{secret_name}
DELETE /orgs/{org}/agents/secrets/{secret_name}
GET /orgs/{org}/agents/secrets/{secret_name}/repositories
PUT /orgs/{org}/agents/secrets/{secret_name}/repositories
PUT /orgs/{org}/agents/secrets/{secret_name}/repositories/{repository_id}
DELETE /orgs/{org}/agents/secrets/{secret_name}/repositories/{repository_id}
GET /orgs/{org}/agents/variables
POST /orgs/{org}/agents/variables
GET /orgs/{org}/agents/variables/{name}
DELETE /orgs/{org}/agents/variables/{name}
PATCH /orgs/{org}/agents/variables/{name}
GET /orgs/{org}/agents/variables/{name}/repositories
PUT /orgs/{org}/agents/variables/{name}/repositories
PUT /orgs/{org}/agents/variables/{name}/repositories/{repository_id}
DELETE /orgs/{org}/agents/variables/{name}/repositories/{repository_id}
POST /orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}/jobs
GET /orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}/jobs/{job_id}
GET /orgs/{org}/copilot-spaces
POST /orgs/{org}/copilot-spaces
GET /orgs/{org}/copilot-spaces/{space_number}
PUT /orgs/{org}/copilot-spaces/{space_number}
DELETE /orgs/{org}/copilot-spaces/{space_number}
GET /orgs/{org}/copilot-spaces/{space_number}/collaborators
POST /orgs/{org}/copilot-spaces/{space_number}/collaborators
PUT /orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}
DELETE /orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}
GET /orgs/{org}/copilot-spaces/{space_number}/resources
POST /orgs/{org}/copilot-spaces/{space_number}/resources
GET /orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}
PUT /orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}
DELETE /orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}
GET /orgs/{org}/copilot/coding-agent/permissions
PUT /orgs/{org}/copilot/coding-agent/permissions
GET /orgs/{org}/copilot/coding-agent/permissions/repositories
PUT /orgs/{org}/copilot/coding-agent/permissions/repositories
PUT /orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}
DELETE /orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}
GET /orgs/{org}/copilot/content_exclusion
PUT /orgs/{org}/copilot/content_exclusion
GET /orgs/{org}/copilot/metrics/reports/organization-1-day
GET /orgs/{org}/copilot/metrics/reports/organization-28-day/latest
GET /orgs/{org}/copilot/metrics/reports/repos-1-day
GET /orgs/{org}/copilot/metrics/reports/user-teams-1-day
GET /orgs/{org}/copilot/metrics/reports/users-1-day
GET /orgs/{org}/copilot/metrics/reports/users-28-day/latest
GET /orgs/{org}/dependabot/repository-access
PATCH /orgs/{org}/dependabot/repository-access
PUT /orgs/{org}/dependabot/repository-access/default-level
GET /orgs/{org}/interaction-limits/pulls/creation-cap
PATCH /orgs/{org}/interaction-limits/pulls/creation-cap
GET /orgs/{org}/issue-fields
POST /orgs/{org}/issue-fields
DELETE /orgs/{org}/issue-fields/{issue_field_id}
PATCH /orgs/{org}/issue-fields/{issue_field_id}
POST /orgs/{org}/projectsV2/{project_number}/views
GET /orgs/{org}/projectsV2/{project_number}/views/{view_number}/items
GET /orgs/{org}/secret-scanning/custom-patterns
POST /orgs/{org}/secret-scanning/custom-patterns
DELETE /orgs/{org}/secret-scanning/custom-patterns
PATCH /orgs/{org}/secret-scanning/custom-patterns/{pattern_id}
GET /repos/{owner}/{repo}/actions/concurrency_groups
GET /repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}
GET /repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups
GET /repos/{owner}/{repo}/agents/organization-secrets
GET /repos/{owner}/{repo}/agents/organization-variables
GET /repos/{owner}/{repo}/agents/secrets
GET /repos/{owner}/{repo}/agents/secrets/public-key
GET /repos/{owner}/{repo}/agents/secrets/{secret_name}
PUT /repos/{owner}/{repo}/agents/secrets/{secret_name}
DELETE /repos/{owner}/{repo}/agents/secrets/{secret_name}
GET /repos/{owner}/{repo}/agents/variables
POST /repos/{owner}/{repo}/agents/variables
GET /repos/{owner}/{repo}/agents/variables/{name}
DELETE /repos/{owner}/{repo}/agents/variables/{name}
PATCH /repos/{owner}/{repo}/agents/variables/{name}
GET /repos/{owner}/{repo}/code-quality/findings
GET /repos/{owner}/{repo}/code-quality/findings/{finding_number}
GET /repos/{owner}/{repo}/code-quality/setup
PATCH /repos/{owner}/{repo}/code-quality/setup
GET /repos/{owner}/{repo}/copilot/cloud-agent/configuration
GET /repos/{owner}/{repo}/dependency-graph/sbom/fetch-report/{sbom_uuid}
GET /repos/{owner}/{repo}/dependency-graph/sbom/generate-report
GET /repos/{owner}/{repo}/hash-algorithm
GET /repos/{owner}/{repo}/interaction-limits/pulls/bypass-list
PUT /repos/{owner}/{repo}/interaction-limits/pulls/bypass-list
DELETE /repos/{owner}/{repo}/interaction-limits/pulls/bypass-list
GET /repos/{owner}/{repo}/interaction-limits/pulls/creation-cap
PATCH /repos/{owner}/{repo}/interaction-limits/pulls/creation-cap
GET /repos/{owner}/{repo}/issue-types
PUT /repos/{owner}/{repo}/issues/comments/{comment_id}/pin
DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/pin
GET /repos/{owner}/{repo}/issues/{issue_number}/issue-field-values
PUT /repos/{owner}/{repo}/issues/{issue_number}/issue-field-values
POST /repos/{owner}/{repo}/issues/{issue_number}/issue-field-values
DELETE /repos/{owner}/{repo}/issues/{issue_number}/issue-field-values/{issue_field_id}
GET /repos/{owner}/{repo}/issues/{issue_number}/suggestions
POST /repos/{owner}/{repo}/issues/{issue_number}/suggestions/{suggestion_id}/approve
POST /repos/{owner}/{repo}/issues/{issue_number}/suggestions/{suggestion_id}/dismiss
PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge-async
GET /repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}
GET /repos/{owner}/{repo}/secret-scanning/custom-patterns
POST /repos/{owner}/{repo}/secret-scanning/custom-patterns
DELETE /repos/{owner}/{repo}/secret-scanning/custom-patterns
PATCH /repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}
GET /repos/{owner}/{repo}/stacks
POST /repos/{owner}/{repo}/stacks
GET /repos/{owner}/{repo}/stacks/{stack_number}
POST /repos/{owner}/{repo}/stacks/{stack_number}/add
POST /repos/{owner}/{repo}/stacks/{stack_number}/unstack
GET /repos/{owner}/{repo}/stargazers/count
POST /users/{user_id}/projectsV2/{project_number}/views
GET /users/{username}/copilot-spaces
POST /users/{username}/copilot-spaces
GET /users/{username}/copilot-spaces/{space_number}
PUT /users/{username}/copilot-spaces/{space_number}
DELETE /users/{username}/copilot-spaces/{space_number}
GET /users/{username}/copilot-spaces/{space_number}/collaborators
POST /users/{username}/copilot-spaces/{space_number}/collaborators
PUT /users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}
DELETE /users/{username}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}
GET /users/{username}/copilot-spaces/{space_number}/resources
POST /users/{username}/copilot-spaces/{space_number}/resources
GET /users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}
PUT /users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}
DELETE /users/{username}/copilot-spaces/{space_number}/resources/{space_resource_id}
GET /users/{username}/projectsV2/{project_number}/views/{view_number}/items
GET /users/{username}/settings/billing/ai_credit/usage
POST /organizations/{org}/settings/billing/budgets
Deprecations
- Deprecated
GET /assignments/{assignment_id}/grades
- Deprecated
GET /classrooms
- Deprecated
GET /classrooms/{classroom_id}
- Deprecated
GET /classrooms/{classroom_id}/assignments
- Deprecated
GET /assignments/{assignment_id}
- Deprecated
GET /assignments/{assignment_id}/accepted_assignments
Breaking changes
Deleted endpoints
- Breaking
GET /organizations/{org}/dependabot/repository-access
- Breaking
PATCH /organizations/{org}/dependabot/repository-access
- Breaking
PUT /organizations/{org}/dependabot/repository-access/default-level
- Breaking
GET /organizations/{org}/org-properties/values
- Breaking
PATCH /organizations/{org}/org-properties/values
- Breaking
GET /orgs/{org}/copilot/metrics
- Breaking
GET /orgs/{org}/team/{team_slug}/copilot/metrics
- Breaking
GET /orgs/{org}/teams/{team_slug}/discussions
- Breaking
POST /orgs/{org}/teams/{team_slug}/discussions
- Breaking
GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}
- Breaking
DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}
- Breaking
PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}
- Breaking
GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments
- Breaking
POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments
- Breaking
GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}
- Breaking
DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}
- Breaking
PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}
- Breaking
GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions
- Breaking
POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions
- Breaking
DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}
- Breaking
GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions
- Breaking
POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions
- Breaking
DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}
- Breaking
GET /repos/{owner}/{repo}/tags/protection
- Breaking
POST /repos/{owner}/{repo}/tags/protection
- Breaking
DELETE /repos/{owner}/{repo}/tags/protection/{tag_protection_id}
- Breaking
GET /teams/{team_id}/discussions
- Breaking
POST /teams/{team_id}/discussions
- Breaking
GET /teams/{team_id}/discussions/{discussion_number}
- Breaking
DELETE /teams/{team_id}/discussions/{discussion_number}
- Breaking
PATCH /teams/{team_id}/discussions/{discussion_number}
- Breaking
GET /teams/{team_id}/discussions/{discussion_number}/comments
- Breaking
POST /teams/{team_id}/discussions/{discussion_number}/comments
- Breaking
GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}
- Breaking
DELETE /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}
- Breaking
PATCH /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}
- Breaking
GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions
- Breaking
POST /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions
- Breaking
GET /teams/{team_id}/discussions/{discussion_number}/reactions
- Breaking
POST /teams/{team_id}/discussions/{discussion_number}/reactions
- 28.x
28.0.0
1 Aug 2026- Removed
Drop projects-classic endpoints, add GitHub API endpoints: cache limits (retention & storage) for repos/orgs/enterprises, billing budgets & usage, artifacts deployment metadata, and projectsV2 drafts & fields
- Breaking
Removed
/orgs/{org}/projects - Breaking
Removed
/orgs/{org}/settings/billing/actions
Bug Fixes
Add additional types to binary body endpoints
Mark int64 as either number or BigInt
Features
- Removed
Drop projects-classic endpoints, add GitHub API endpoints: cache limits (retention & storage) for repos/orgs/enterprises, billing budgets & usage, artifacts deployment metadata, and projectsV2 drafts & fields
Breaking changes
- Breaking
Removed
/orgs/{org}/projects - Breaking
Removed
/orgs/{org}/settings/billing/actions - Breaking
Removed
/orgs/{org}/settings/billing/packages - Breaking
Removed
/orgs/{org}/settings/billing/shared-storage - Breaking
Removed
/orgs/{org}/teams/{team_slug}/projects - Breaking
Removed
/orgs/{org}/teams/{team_slug}/projects/{project_id} - Breaking
Removed
/projects/columns/{column_id} - Breaking
Removed
/projects/columns/{column_id}/moves - Breaking
Removed
/projects/{project_id} - Breaking
Removed
/projects/{project_id}/collaborators - Breaking
Removed
/projects/{project_id}/collaborators/{username} - Breaking
Removed
/projects/{project_id}/collaborators/{username}/permission - Breaking
Removed
/repos/{owner}/{repo}/projects - Breaking
Removed
/teams/{team_id}/projects - Breaking
Removed
/teams/{team_id}/projects/{project_id} - Breaking
Removed
/user/projects - Breaking
Removed
/users/{username}/projects - Breaking
Removed
/users/{username}/settings/billing/actions - Breaking
Removed
/users/{username}/settings/billing/packages - Breaking
Removed
/users/{username}/settings/billing/shared-storage
- 27.x
27.0.0
30 Oct 2025- Breaking
Several endpoints ID change
- Breaking
Removed endpoints
Add GHES 3.18, immutable releases, enterprise team membership, enterprise team organization, custom runner images, many type additions and improvements
- 26.x
26.0.0
16 Sep 2025- Breaking
Remove GHES 3.13
Remove GHES 3.13, new Projects v2 endpoints, new code scanning dismissal endpoints, many other endpoints
- 25.x
25.1.0
25 May 2025Add GHES 3.17, new
/credentials/revoke,/users/{username}/settings/billing/usage,/enterprises/{enterprise}/members/{username}/copilotendpoints, description updates
25.0.0
9 Apr 2025- Breaking
Remove Copilot usage endpoints
New
/orgs/{org}/campaigns,/orgs/{org}/campaigns/{campaign_number}endpoints, remove Copilot usage endpoints, description updates
- 24.x
24.2.0
18 Mar 2025New
/orgs/{org}/issue-types,/orgs/{org}/issue-types/{issue_type_id}enpoints, add issue type to responses, add dismissal request for code scanning for GHES and GHEC, description updates
24.1.0
18 Mar 2025- Deprecated
Add GHES 3.16, add new
epss_percentagesorting to advisories, newepss_percentageparameter for dependabot alerts, newdismissal_approved_byparameter to code scanning alerts, new/enterprises/{enterprise}/actions/hosted-runners,/orgs/{org}/actions/hosted-runners,/orgs/{org}/settings/network-configurations,/orgs/{org}/rulesets/{ruleset_id}/history,/repos/{owner}/{repo}/rulesets/{ruleset_id}/historyendpoints, deprecate Projects (classic), deprecate Copilot usage endpoints, description updates
24.0.0
15 Feb 2025- Breaking
Remove GHES 3.10 and 3.11 and GHAE
New
dismissed_commentandfixed_atattributes on code scanning alerts, description updates, remove GHES 3.10 and 3.11, remove GHAE
Features
New
dismissed_commentandfixed_atattributes on code scanning alerts, description updates, remove GHES 3.10 and 3.11, remove GHAE
Breaking changes
- Breaking
Remove GHES 3.10 and 3.11 and GHAE
- 23.x
23.0.1
8 Jan 2025Replace missing component with inline definition
23.0.0
8 Jan 2025- Deprecated
Deprecate
/orgs/{org}/{security_product}/{enablement} - Breaking
Remove GHES 3.9
Remove GHES 3.9, new action runner groups endpoints, new code scanning alerts autofix endpoints, new sub-issues endpoints, new private registries enpoints, new code security endpoints, various description updates
Features
Remove GHES 3.9, new action runner groups endpoints, new code scanning alerts autofix endpoints, new sub-issues endpoints, new private registries enpoints, new code security endpoints, various description updates
Description updates
New
/enterprises/{enterprise}/copilot/billing/seatsNew
/enterprises/{enterprise}/settings/billing/cost-centersNew
/enterprises/{enterprise}/settings/billing/usageNew
/enterprises/{enterprise}/code-security/configurations/defaultsNew
/enterprises/{enterprise}/code-security/configurations/{configuration_id}New
/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attachNew
/orgs/{org}/actions/runner-groupsNew
/orgs/{org}/actions/runner-groups/{runner_group_id}New
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositoriesNew
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}New
/orgs/{org}/actions/runner-groups/{runner_group_id}/runnersNew
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}New
/orgs/{org}/copilot/metricsNew
/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}New
/orgs/{org}/insights/api/subject-statsNew
/orgs/{org}/insights/api/summary-statsNew
/orgs/{org}/insights/api/summary-stats/users/{user_id}New
/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}New
/orgs/{org}/insights/api/time-statsNew
/orgs/{org}/insights/api/time-stats/users/{user_id}New
/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}New
/orgs/{org}/insights/api/user-stats/{user_id}New
/orgs/{org}/private-registriesNew
/orgs/{org}/private-registries/public-keyNew
/orgs/{org}/private-registries/{secret_name}New
/orgs/{org}/team/{team_slug}/copilot/metricsNew
/orgs/{org}/team/{team_slug}/copilot/usage- Deprecated
Deprecate
/orgs/{org}/{security_product}/{enablement} New
/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofixNew
/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commitsNew
/repos/{owner}/{repo}/code-security-configurationAdd discriminators for various properties
New
/repos/{owner}/{repo}/issues/{issue_number}/sub_issuesNew
/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priorityNew
/repos/{owner}/{repo}/secret-scanning/push-protection-bypassesNew
/repos/{owner}/{repo}/secret-scanning/scan-history
Breaking changes
- Breaking
Remove GHES 3.9
- 22.x
22.2.0
29 Apr 2024Add copilot endpoints, add reusable components, description updates
22.1.0
15 Apr 2024Remove all_of for issue, workflow_run, alert, release, pull_request, marketplace_purchase
22.0.1
9 Apr 2024Description updates, new parameter for
enterprise-admin/license-upload,default_valuefield can now also bestringon custom_property
22.0.0
5 Apr 2024- Breaking
Renames [repository-rule-params-code-scanning-threshold to repository-rule-params-code-scanning-tool, security_alerts to security_alerts_threshold], renames fields[repository-rule-params-code-scanning-threshold.alerts to repository-rule-params-code-scanning-tool.alerts_threshold, repository-rule-params-code-scanning-threshold.security_alerts to repository-rule-params-code-scanning-tool.security_alerts_threshold]
- Breaking
Renames [repository-rule-params-code-scanning-threshold to repository-rule-params-code-scanning-tool, security_alerts to security_alerts_threshold], renames fields[repository-rule-params-code-scanning-threshold.alerts to repository-rule-params-code-scanning-tool.alerts_threshold, repository-rule-params-code-scanning-threshold.security_alerts to repository-rule-params-code-scanning-tool.security_alerts_threshold]
- 21.x
21.2.0
3 Apr 2024security: Add provenance
21.1.0
3 Apr 2024Creates a component for security-advisory-ecosystems, adds deprecated attribute to workflow-run-requested.hub_url, BREAKING CHANGES: [renames operation repository-rule-params-thresholds to repository-rule-params-code-scanning-threshold, renames repository-rule-params-thresholds[code_scanning_alert_threshold, code_scanning_security_alert_threshold] to repository-rule-params-code-scanning-threshold[alerts,security_alerts]], adds property repository-rule-params-code-scanning-threshold[tool], adds object secret-scanning-location-wiki-commit
21.0.0
1 Apr 2024- Breaking
Updates multiple endpoints to use owner + repo in place of repository_id
Breaking changes
- Breaking
Updates multiple endpoints to use owner + repo in place of repository_id
- 20.x
20.0.0
22 Feb 2024- Breaking
Drop GHES 3.7
Add GHES 3.11, GHES 3.12, remove GHES 3.7, many description updates and new enpoints
- 19.x
19.1.0
28 Nov 2023Drop GHES 3.7 and OpenAPI updates
19.0.2
25 Oct 2023Description and sample payload updates
19.0.1
24 Oct 2023Description updates
19.0.0
23 Sep 2023- Breaking
Drop GHES 3.6
New GitHub advisories, GitHub classroom, copilot endpoints, description updates, remove GHES 3.6, add GHES 3.10
- 18.x
18.1.0
22 Sep 2023New GitHub advisories, GitHub classroom, copilot endpoints, description updates, remove GHES 3.6, add GHES 3.10
18.0.0
9 Jun 2023- Breaking
Drop GHES 3.5
Schema updates on 'codespaces' endpoint and other minor updates
Schema updates for gpg-key
Features
Schema updates on 'codespaces' endpoint and other minor updates
added 'security_and_analysis' property
added 'geo' property
'line' property not required anymore
remove 'key' property
update descriptions
property type updates
Schema updates for gpg-key
remove 'subkeys' subproperty for 'gpg-key'
Schema updates for Check Run
update 'url' for externalDocs for Check Runs
update descriptions
remove 'status' for Check Run
Many unreleased OpenAPI updates
update descriptions
add '/orgs/{org}/actions/runners/generate-jitconfig' endpoint
add references to 'page' and 'per-page'
add '/repos/{owner}/{repo}/actions/runners/generate-jitconfig' endpoint
complement responses for some endpoints (create issue, remove repo from an app installation, list repository teams)
add 'enabledForGitHubApps' to 'x-github' header
add 'summary' to 'merge-group-checks-requested'
add 'domains' to 'api-overview'
add 'html' to ruleset
add 'c-cpp', 'java-kotlin' and 'javascript-typescript' to 'languages'
add 'runner-jitconfig' to schema
add new properties to 'org-ruleset-items'
add 'actions_runner_jitconfig' to schema
Breaking changes
- Breaking
Drop GHES 3.5
- 17.x
17.2.0
16 May 2023New merge group endpoints, description updates, GHES 3.9 support
17.1.2
11 May 2023Remove "empty object" type from
gists-updateoperation
17.1.1
5 May 2023Update the types for the patch to fix occurences of
never
17.1.0
28 Apr 2023- Security
New deployment protection rule endpoints, new private reporting of security vulnerability endpoint
17.0.0
20 Apr 2023- Breaking
Remove GHES 3.4
Breaking changes
- Breaking
Remove GHES 3.4
- 16.x
16.1.0
19 Apr 2023Many unreleased OpenAPI updates
16.0.0
19 Jan 2023- Breaking
Removes GHES 3.3 support as it was deprecated recently
Remove GHES 3.3 support
- 15.x
- 14.x
14.0.0
27 Sep 2022- Breaking
Types for API operations only available to GitHub Enterprise Cloud (GHEC) customers will no longer appear in the
@octokit/openapi-typespackage. These will only appear in the GHEC-specific@octokit/openapi-types-ghecpackage. The@octokit/openapi-typespackage now only includes APIs available to customers on GitHub.com using the Free, Pro and Teams plans. Publish new GitHub Enterprise Cloud (GHEC) specific
@octokit/openapi-types-ghecpackage, plus lots of API changesAdd support for new "Get a Dependabot alert" API (
GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number})
Breaking changes
- Breaking
Types for API operations only available to GitHub Enterprise Cloud (GHEC) customers will no longer appear in the
@octokit/openapi-typespackage. These will only appear in the GHEC-specific@octokit/openapi-types-ghecpackage. The@octokit/openapi-typespackage now only includes APIs available to customers on GitHub.com using the Free, Pro and Teams plans.
Features
Publish new GitHub Enterprise Cloud (GHEC) specific
@octokit/openapi-types-ghecpackage, plus lots of API changesAdd support for new "Get a Dependabot alert" API (
GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number})Add support for new "Update a Dependabot alert" API (
PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number})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
Add support for new "Get an organization public key" (
GET /organizations/{org}/codespaces/secrets/public-key) Codespaces APIAdd support for new "Get an organization secret" (
GET /organizations/{org}/codespaces/secrets/{secret_name}) Codespaces APIAdds support for new "Create or update an organization secret" (
PUT /organizations/{org}/codespaces/secrets/{secret_name}) Codespaces APIAdd support for new "Delete an organization secret" (
DELETE /organizations/{org}/codespaces/secrets/{secret_name}) Codespaces APIAdd support for new "List selected repositories for an organization secret" (
GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories) Codespaces APIAdd support for new "Set selected repositories for an organization secret" (
PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories) Codespaces APIAdd support for new "Add selected repository to an organization secret" (
PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}) Codespaces APIAdd support for new "Remove selected repository from an organization secret" (
DELETE /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}) Codespaces APIAdd support for
resolution_commentattribute returned on secret scanning alertsAdd support for new
scopeattribute returned by the "Get a diff of the dependencies between commits" (GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}) API
Fixes
Tweak documentation for repo starring related APIs (
GET /repos/{owner}/{repo}/stargazers,GET /users/{username}/starredandGET /user/starred) to clarify whatAcceptheader to send to get information about when stars were createdTweak 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 forksDocument the
sizeattribute returned on repos across the APIDocument that APIs can return
422errors when an endpoint has been spammed with many requestsDocument
301status returned by labels-related APIs if the repo has been renamed or movedDocument
404 Not Foundstatus returned by labels-related APIs
- 13.x
13.13.1
29 Sep 2022Revert "feat: publish new GitHub Enterprise Cloud (GHEC) specific
@octokit/openapi-types-ghecpackage, plus lots of API changes (#251)"
13.13.0
27 Sep 2022This version was published accidentally as a minor version, when it should have been a major version.
13.12.0
16 Sep 2022Add support for new
display_titleattribute returned on workflow runs across the API (e.g. inGET /repos/{owner}/{repo}/actions/runs)
13.11.0
15 Sep 2022Add new "List CodeQL databases for a repository" API (
GET /repos/{owner}/{repo}/code-scanning/codeql/databases)Add new "Get a CodeQL database for a repository" API (
GET /repos/{owner}/{repo}/code-scanning/codeql/databases/{language})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
Add new "List CodeQL databases for a repository" API (
GET /repos/{owner}/{repo}/code-scanning/codeql/databases)Add new "Get a CodeQL database for a repository" API (
GET /repos/{owner}/{repo}/code-scanning/codeql/databases/{language})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 conflictsCorrect casing of
github advanced securitytoGitHub Advanced Securityin descriptionsUpdate docs for the "Update a secret scanning alert" API (
PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}) to clarify that aresolutionmust be provided when settingstatetoresolvedUse
enums rather thanstringtypes with a list of accepted values in thedescription(e.g. theconclusionattribute returned in the "Get a job for a workflow run" API [GET /repos/{owner}/{repo}/actions/jobs/{job_id}])
13.10.0
13 Sep 2022Add support for new
github_com_enterprise_rolesattribute returned by the "List enterprise consumed licenses" API (GET /enterprises/{enterprise}/consumed-licenses), marking the old singulargithub_com_enterprise_roleattribute as deprecatedAdd support for filtering the "List repository collaborators" API (
GET /repos/{owner}/{repo}/collaborators) bypermissionusing a query paramUpdate type documentation to flag the "List enterprise consumed licenses" API (
GET /enterprises/{enterprise}/consumed-licenses) as beta
Add support for new
github_com_enterprise_rolesattribute returned by the "List enterprise consumed licenses" API (GET /enterprises/{enterprise}/consumed-licenses), marking the old singulargithub_com_enterprise_roleattribute as deprecatedAdd support for filtering the "List repository collaborators" API (
GET /repos/{owner}/{repo}/collaborators) bypermissionusing a query paramUpdate type documentation to flag the "List enterprise consumed licenses" API (
GET /enterprises/{enterprise}/consumed-licenses) as betaClarify in type documentation that the "Get or update file contents" API (
PUT /repos/{owner}/{repo}/contents/{path}) requires theworkflowscopeAdding missing type documentation for the "List repository webhooks" API (
GET /repos/{owner}/{repo}/hooks)
13.9.1
9 Sep 2022Tweak 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})
13.9.0
7 Sep 2022- Deprecated
Mark
use_squash_pr_title_as_defaultattribute on repos as deprecated in favour ofsquash_merge_commit_title Add support for 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 support for new
description,base_role,permissions,organization,created_atandupdated_atfields where custom repo roles are returned in the API
Add support for 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 support for new
description,base_role,permissions,organization,created_atandupdated_atfields where custom repo roles are returned in the APIUpdate description of 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...")- Deprecated
Mark
use_squash_pr_title_as_defaultattribute on repos as deprecated in favour ofsquash_merge_commit_title Update description of "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
sharequest body parameter in the "Delete a file" API (DELETE /repos/{owner}/{repo}/contents/{path})
13.8.0
5 Sep 2022Add 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) byhead_shaTweak the recently-added
state_reasonattribute on issues to be a enum (completed,not_plannedorreopened) rather than an unbounded string
13.7.0
2 Sep 2022Add support for
is_alphanumericboolean 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 APIAdd support for
rule.help_uriattribute 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_enabledboolean attribute returned on repos across the API
Add support for
is_alphanumericboolean 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 APIAdd support for
rule.help_uriattribute 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_enabledboolean attribute returned on repos across the APITweak documentation for "Create an autolink reference for a repository" (
POST /repos/{owner}/{repo}/autolinks) to read more smoothlyClarify 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 repoDrop
302as a potential response status code forGET /orgs/{org}/members, which hasn't been returned for nearly 8 yearsAdd
503as a potential response status code across various API operations
13.6.0
31 Aug 2022Add 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_repositoriesandsecret_scanning_push_protection_enabled_for_new_repositoriesread-write boolean attributes on organizationsAdd support for new
last_known_stop_noticeattribute on Codespace machines across the API
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_repositoriesandsecret_scanning_push_protection_enabled_for_new_repositoriesread-write boolean attributes on organizationsAdd support for new
last_known_stop_noticeattribute on Codespace machines across the APIAdd 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)
13.5.0
30 Aug 2022Add support for sorting with
sortanddirectionquerystring parameters when listing a repo's code scanning analyses withGET /repos/{owner}/{repo}/code-scanning/analysesAdd support for
default_branch_onlyboolean request body parameter when creating a fork withPOST /repos/{owner}/{repo}/forksAdd support for
state_reasonrequest body parameter when updating an issue withPATCH /repos/{owner}/{repo}/issues/{issue_number}
Add support for sorting with
sortanddirectionquerystring parameters when listing a repo's code scanning analyses withGET /repos/{owner}/{repo}/code-scanning/analysesAdd support for
default_branch_onlyboolean request body parameter when creating a fork withPOST /repos/{owner}/{repo}/forksAdd support for
state_reasonrequest body parameter when updating an issue withPATCH /repos/{owner}/{repo}/issues/{issue_number}Update description of
GET /organizations/{organization_id}/custom_rolesto clarify required permissionsUpdate description of
DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}to clarify how sets of analyses workUpdate description for
GET /repos/{owner}/{repo}/contents/{path}to clarify that download links expire
13.4.0
20 Aug 2022Add
web_commit_signoff_requiredrequest body parameter inPOST /orgs/{org}/repos,PATCH /repos/{owner}/{repo}andPATCH /repos/{owner}/{repo}Add
web_commit_signoff_requiredresponse attribute where repositories and organizations are returned in the API
13.3.0
19 Aug 2022Add
squash_merge_commit_title,squash_merge_commit_message,merge_commit_titleandmerge_commit_messagerequest body parameters inPOST /orgs/{org}/repos,PATCH /repos/{owner}/{repo},POST /user/reposAdd
squash_merge_commit_title,squash_merge_commit_message,merge_commit_titleandmerge_commit_messageresponse attributes where repositories are returned in the API
13.2.0
18 Aug 2022Add new
permissions.organization_custom_rolesresponse attribute inGET /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/installationsandGET /users/{username}/installationAdd new
permissions.organization_custom_rolesrequest body parameter inPOST /app/installations/{installation_id}/access_tokensandPOST /applications/{client_id}/token/scopedUpdate description for
manifestspassed in request body toPOST /repos/{owner}/{repo}/dependency-graph/snapshots
A whole project to check? Paste its package.json in the dependency check: every deprecated, outdated or vulnerable dependency, with what to upgrade to. Free, no account.