Generate API docs from spec#1474
Closed
github-actions[bot] wants to merge 0 commit into
Closed
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
July 17, 2026 11:27
200bb25 to
49f4fd6
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
Automated documentation sync with no runtime or product logic changes; main risk is inaccurate or missing endpoint details if the upstream spec is wrong.
Overview
Regenerates the Snyk API reference under
developer-tools/snyk-api/referencefrom the OpenAPI sources, including an updatedrest-spec.jsonpulled fromapi.snyk.ioand the in-repo v1 spec.Each reference page is rebuilt as GitBook markdown with embedded
{% openapi %}blocks (grouped by API category), and the Reference section ofdeveloper-tools/SUMMARY.mdis refreshed so the nav matches the generated set—including newer REST areas such as Assignments, SastRuleExtensions, SecretsRuleExtensions, and SecretsSettings.Reviewed by Cursor Bugbot for commit 49f4fd6. Bugbot is set up for automated code reviews on this repo. Configure here.