Generate API docs from spec - #1778
Closed
github-actions[bot] wants to merge 0 commit into
Closed
github-actions[bot] wants to merge 0 commit into
github-actions[bot] wants to merge 0 commit into
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
28 times, most recently
from
September 11, 2026 12:25
1384e6e to
36b1350
Compare
github-actions
Bot
force-pushed
the
docs/automatic-api-docs-update
branch
18 times, most recently
from
September 14, 2026 10:03
26d8643 to
1c8dea1
Compare
github-actions
Bot
force-pushed
the
docs/automatic-api-docs-update
branch
from
September 14, 2026 10:07
1c8dea1 to
4267044
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
Low Risk
Documentation-only output from the official OpenAPI sources; no application or auth logic changes.
Overview
Automated refresh of Snyk API reference documentation produced by the
sync-api-docsworkflow runningtools/api-docs-generator(make run).The generator pulls the latest REST OpenAPI spec, uses the in-repo v1 spec, and rewrites generated reference pages under
developer-tools/snyk-api/reference/(and related synced assets such as the API changelog). The PR body menu lists the full set of reference topics after this run—including entries like Assignments, Secrets rule/settings pages, and SastRuleExtensions that may need a manualdeveloper-tools/SUMMARY.mdupdate if they are new or renamed (the generator does not editSUMMARY.md).Reviewers should spot-check regenerated endpoints against the specs rather than line-by-line prose.
Reviewed by Cursor Bugbot for commit 4267044. Bugbot is set up for automated code reviews on this repo. Configure here.