Generate API docs from spec#1487
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 20, 2026 19:30
1ec75f6 to
cca7f74
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 OpenAPI specs; no runtime or auth behavior changes, though incorrect spec-to-doc generation could misdocument APIs.
Overview
Automated refresh of the GitBook Snyk API Reference under
developer-tools/snyk-api/reference/, driven by the API docs synchronization action from the V1 and REST OpenAPI assets.The generated navigation now covers the full tag set listed in the PR (e.g. Assignments, SastRuleExtensions, SecretsRuleExtensions, SecretsSettings, AiBom, and the existing v1/REST resource pages). Individual reference
.mdfiles are rebuilt as OpenAPI embeds pointing atrest-spec.json/v1-api-spec.yaml, so endpoint lists and parameters match the current spec rather than hand-edited docs.Reviewed by Cursor Bugbot for commit cca7f74. Bugbot is set up for automated code reviews on this repo. Configure here.