Generate API docs from spec - #1693
Open
github-actions[bot] wants to merge 1 commit into
Open
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
github-actions
Bot
force-pushed
the
docs/automatic-api-docs-update
branch
from
August 28, 2026 22:17
fedfdb8 to
69f340f
Compare
github-actions
Bot
force-pushed
the
docs/automatic-api-docs-update
branch
from
August 29, 2026 02:18
69f340f to
0315c8e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR was automatically generated by the API docs synchronization action. Please review the changes and merge if they look good.
Note
Medium Risk
Documents a destructive bulk-delete API and a breaking GET /orgs filter change; integrators relying on empty name queries or the trimmed OpenSourceSettings page need to update.
Overview
This PR refreshes rest-spec.json and the generated Snyk API reference from the upstream OpenAPI spec.
Projects: Documents a new POST
/orgs/{org_id}/projects/bulk-deleteendpoint (API version 2024-10-15) to delete up to 100 projects per call, with optionalexclude_from_future_scansand per-project outcomes inmeta.deleted/meta.failed(HTTP 200 even when some deletes fail). The Projects reference page adds the corresponding OpenAPI embed.Organizations: GET
/orgsnow requires thenamequery parameter to be at least 1 character when used (breaking; noted in the changelog).Other spec changes: Inventory asset
risk_factorsis marked deprecated; an asset-search example filter switches fromrisk_factors/Deployedtosources/github. Vulnerability payloads gain optionalinsights.triage_adviceandmodule_name.OpenSourceSettings reference: The page title is corrected to OpenSourceSettings, and generated OpenAPI blocks are reduced to GET
/orgs/{org_id}/settings/opensourceonly (broker and private-registry operations are no longer listed on this page).Reviewed by Cursor Bugbot for commit 0315c8e. Bugbot is set up for automated code reviews on this repo. Configure here.